Documentation
¶
Index ¶
- type ApiConnection
- type ApiConnectionArgs
- type ApiConnectionArray
- type ApiConnectionArrayInput
- type ApiConnectionArrayOutput
- func (ApiConnectionArrayOutput) ElementType() reflect.Type
- func (o ApiConnectionArrayOutput) Index(i pulumi.IntInput) ApiConnectionOutput
- func (o ApiConnectionArrayOutput) ToApiConnectionArrayOutput() ApiConnectionArrayOutput
- func (o ApiConnectionArrayOutput) ToApiConnectionArrayOutputWithContext(ctx context.Context) ApiConnectionArrayOutput
- type ApiConnectionInput
- type ApiConnectionMap
- type ApiConnectionMapInput
- type ApiConnectionMapOutput
- func (ApiConnectionMapOutput) ElementType() reflect.Type
- func (o ApiConnectionMapOutput) MapIndex(k pulumi.StringInput) ApiConnectionOutput
- func (o ApiConnectionMapOutput) ToApiConnectionMapOutput() ApiConnectionMapOutput
- func (o ApiConnectionMapOutput) ToApiConnectionMapOutputWithContext(ctx context.Context) ApiConnectionMapOutput
- type ApiConnectionOutput
- func (o ApiConnectionOutput) DisplayName() pulumi.StringOutput
- func (ApiConnectionOutput) ElementType() reflect.Type
- func (o ApiConnectionOutput) ManagedApiId() pulumi.StringOutput
- func (o ApiConnectionOutput) Name() pulumi.StringOutput
- func (o ApiConnectionOutput) ParameterValues() pulumi.StringMapOutput
- func (o ApiConnectionOutput) ResourceGroupName() pulumi.StringOutput
- func (o ApiConnectionOutput) Tags() pulumi.StringMapOutput
- func (o ApiConnectionOutput) ToApiConnectionOutput() ApiConnectionOutput
- func (o ApiConnectionOutput) ToApiConnectionOutputWithContext(ctx context.Context) ApiConnectionOutput
- type ApiConnectionState
- type GetManagedApiArgs
- type GetManagedApiOutputArgs
- type GetManagedApiResult
- type GetManagedApiResultOutput
- func (GetManagedApiResultOutput) ElementType() reflect.Type
- func (o GetManagedApiResultOutput) Id() pulumi.StringOutput
- func (o GetManagedApiResultOutput) Location() pulumi.StringOutput
- func (o GetManagedApiResultOutput) Name() pulumi.StringOutput
- func (o GetManagedApiResultOutput) Tags() pulumi.StringMapOutput
- func (o GetManagedApiResultOutput) ToGetManagedApiResultOutput() GetManagedApiResultOutput
- func (o GetManagedApiResultOutput) ToGetManagedApiResultOutputWithContext(ctx context.Context) GetManagedApiResultOutput
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApiConnection ¶
type ApiConnection struct { pulumi.CustomResourceState // A display name for this API Connection. Changing this forces a new API Connection to be created. DisplayName pulumi.StringOutput `pulumi:"displayName"` // The ID of the Managed API which this API Connection is linked to. Changing this forces a new API Connection to be created. ManagedApiId pulumi.StringOutput `pulumi:"managedApiId"` // The Name which should be used for this API Connection. Changing this forces a new API Connection to be created. Name pulumi.StringOutput `pulumi:"name"` ParameterValues pulumi.StringMapOutput `pulumi:"parameterValues"` // The name of the Resource Group where this API Connection should exist. Changing this forces a new API Connection to be created. ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"` // A mapping of tags which should be assigned to the API Connection. Tags pulumi.StringMapOutput `pulumi:"tags"` }
Manages an API Connection.
## Example Usage
<!--Start PulumiCodeChooser --> ```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/connections" "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core" "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/servicebus" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleResourceGroup, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{ Name: pulumi.String("example-resources"), Location: pulumi.String("West Europe"), }) if err != nil { return err } example := connections.GetManagedApiOutput(ctx, connections.GetManagedApiOutputArgs{ Name: pulumi.String("servicebus"), Location: exampleResourceGroup.Location, }, nil) exampleNamespace, err := servicebus.NewNamespace(ctx, "example", &servicebus.NamespaceArgs{ Name: pulumi.String("acctestsbn-conn-example"), Location: exampleResourceGroup.Location, ResourceGroupName: exampleResourceGroup.Name, Sku: pulumi.String("Basic"), }) if err != nil { return err } _, err = connections.NewApiConnection(ctx, "example", &connections.ApiConnectionArgs{ Name: pulumi.String("example-connection"), ResourceGroupName: exampleResourceGroup.Name, ManagedApiId: example.ApplyT(func(example connections.GetManagedApiResult) (*string, error) { return &example.Id, nil }).(pulumi.StringPtrOutput), DisplayName: pulumi.String("Example 1"), ParameterValues: pulumi.StringMap{ "connectionString": exampleNamespace.DefaultPrimaryConnectionString, }, Tags: pulumi.StringMap{ "Hello": pulumi.String("World"), }, }) if err != nil { return err } return nil }) }
``` <!--End PulumiCodeChooser -->
## Import
API Connections can be imported using the `resource id`, e.g.
```sh $ pulumi import azure:connections/apiConnection:ApiConnection example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.Web/connections/example-connection ```
func GetApiConnection ¶
func GetApiConnection(ctx *pulumi.Context, name string, id pulumi.IDInput, state *ApiConnectionState, opts ...pulumi.ResourceOption) (*ApiConnection, error)
GetApiConnection gets an existing ApiConnection resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewApiConnection ¶
func NewApiConnection(ctx *pulumi.Context, name string, args *ApiConnectionArgs, opts ...pulumi.ResourceOption) (*ApiConnection, error)
NewApiConnection registers a new resource with the given unique name, arguments, and options.
func (*ApiConnection) ElementType ¶
func (*ApiConnection) ElementType() reflect.Type
func (*ApiConnection) ToApiConnectionOutput ¶
func (i *ApiConnection) ToApiConnectionOutput() ApiConnectionOutput
func (*ApiConnection) ToApiConnectionOutputWithContext ¶
func (i *ApiConnection) ToApiConnectionOutputWithContext(ctx context.Context) ApiConnectionOutput
type ApiConnectionArgs ¶
type ApiConnectionArgs struct { // A display name for this API Connection. Changing this forces a new API Connection to be created. DisplayName pulumi.StringPtrInput // The ID of the Managed API which this API Connection is linked to. Changing this forces a new API Connection to be created. ManagedApiId pulumi.StringInput // The Name which should be used for this API Connection. Changing this forces a new API Connection to be created. Name pulumi.StringPtrInput ParameterValues pulumi.StringMapInput // The name of the Resource Group where this API Connection should exist. Changing this forces a new API Connection to be created. ResourceGroupName pulumi.StringInput // A mapping of tags which should be assigned to the API Connection. Tags pulumi.StringMapInput }
The set of arguments for constructing a ApiConnection resource.
func (ApiConnectionArgs) ElementType ¶
func (ApiConnectionArgs) ElementType() reflect.Type
type ApiConnectionArray ¶
type ApiConnectionArray []ApiConnectionInput
func (ApiConnectionArray) ElementType ¶
func (ApiConnectionArray) ElementType() reflect.Type
func (ApiConnectionArray) ToApiConnectionArrayOutput ¶
func (i ApiConnectionArray) ToApiConnectionArrayOutput() ApiConnectionArrayOutput
func (ApiConnectionArray) ToApiConnectionArrayOutputWithContext ¶
func (i ApiConnectionArray) ToApiConnectionArrayOutputWithContext(ctx context.Context) ApiConnectionArrayOutput
type ApiConnectionArrayInput ¶
type ApiConnectionArrayInput interface { pulumi.Input ToApiConnectionArrayOutput() ApiConnectionArrayOutput ToApiConnectionArrayOutputWithContext(context.Context) ApiConnectionArrayOutput }
ApiConnectionArrayInput is an input type that accepts ApiConnectionArray and ApiConnectionArrayOutput values. You can construct a concrete instance of `ApiConnectionArrayInput` via:
ApiConnectionArray{ ApiConnectionArgs{...} }
type ApiConnectionArrayOutput ¶
type ApiConnectionArrayOutput struct{ *pulumi.OutputState }
func (ApiConnectionArrayOutput) ElementType ¶
func (ApiConnectionArrayOutput) ElementType() reflect.Type
func (ApiConnectionArrayOutput) Index ¶
func (o ApiConnectionArrayOutput) Index(i pulumi.IntInput) ApiConnectionOutput
func (ApiConnectionArrayOutput) ToApiConnectionArrayOutput ¶
func (o ApiConnectionArrayOutput) ToApiConnectionArrayOutput() ApiConnectionArrayOutput
func (ApiConnectionArrayOutput) ToApiConnectionArrayOutputWithContext ¶
func (o ApiConnectionArrayOutput) ToApiConnectionArrayOutputWithContext(ctx context.Context) ApiConnectionArrayOutput
type ApiConnectionInput ¶
type ApiConnectionInput interface { pulumi.Input ToApiConnectionOutput() ApiConnectionOutput ToApiConnectionOutputWithContext(ctx context.Context) ApiConnectionOutput }
type ApiConnectionMap ¶
type ApiConnectionMap map[string]ApiConnectionInput
func (ApiConnectionMap) ElementType ¶
func (ApiConnectionMap) ElementType() reflect.Type
func (ApiConnectionMap) ToApiConnectionMapOutput ¶
func (i ApiConnectionMap) ToApiConnectionMapOutput() ApiConnectionMapOutput
func (ApiConnectionMap) ToApiConnectionMapOutputWithContext ¶
func (i ApiConnectionMap) ToApiConnectionMapOutputWithContext(ctx context.Context) ApiConnectionMapOutput
type ApiConnectionMapInput ¶
type ApiConnectionMapInput interface { pulumi.Input ToApiConnectionMapOutput() ApiConnectionMapOutput ToApiConnectionMapOutputWithContext(context.Context) ApiConnectionMapOutput }
ApiConnectionMapInput is an input type that accepts ApiConnectionMap and ApiConnectionMapOutput values. You can construct a concrete instance of `ApiConnectionMapInput` via:
ApiConnectionMap{ "key": ApiConnectionArgs{...} }
type ApiConnectionMapOutput ¶
type ApiConnectionMapOutput struct{ *pulumi.OutputState }
func (ApiConnectionMapOutput) ElementType ¶
func (ApiConnectionMapOutput) ElementType() reflect.Type
func (ApiConnectionMapOutput) MapIndex ¶
func (o ApiConnectionMapOutput) MapIndex(k pulumi.StringInput) ApiConnectionOutput
func (ApiConnectionMapOutput) ToApiConnectionMapOutput ¶
func (o ApiConnectionMapOutput) ToApiConnectionMapOutput() ApiConnectionMapOutput
func (ApiConnectionMapOutput) ToApiConnectionMapOutputWithContext ¶
func (o ApiConnectionMapOutput) ToApiConnectionMapOutputWithContext(ctx context.Context) ApiConnectionMapOutput
type ApiConnectionOutput ¶
type ApiConnectionOutput struct{ *pulumi.OutputState }
func (ApiConnectionOutput) DisplayName ¶ added in v5.5.0
func (o ApiConnectionOutput) DisplayName() pulumi.StringOutput
A display name for this API Connection. Changing this forces a new API Connection to be created.
func (ApiConnectionOutput) ElementType ¶
func (ApiConnectionOutput) ElementType() reflect.Type
func (ApiConnectionOutput) ManagedApiId ¶ added in v5.5.0
func (o ApiConnectionOutput) ManagedApiId() pulumi.StringOutput
The ID of the Managed API which this API Connection is linked to. Changing this forces a new API Connection to be created.
func (ApiConnectionOutput) Name ¶ added in v5.5.0
func (o ApiConnectionOutput) Name() pulumi.StringOutput
The Name which should be used for this API Connection. Changing this forces a new API Connection to be created.
func (ApiConnectionOutput) ParameterValues ¶ added in v5.5.0
func (o ApiConnectionOutput) ParameterValues() pulumi.StringMapOutput
func (ApiConnectionOutput) ResourceGroupName ¶ added in v5.5.0
func (o ApiConnectionOutput) ResourceGroupName() pulumi.StringOutput
The name of the Resource Group where this API Connection should exist. Changing this forces a new API Connection to be created.
func (ApiConnectionOutput) Tags ¶ added in v5.5.0
func (o ApiConnectionOutput) Tags() pulumi.StringMapOutput
A mapping of tags which should be assigned to the API Connection.
func (ApiConnectionOutput) ToApiConnectionOutput ¶
func (o ApiConnectionOutput) ToApiConnectionOutput() ApiConnectionOutput
func (ApiConnectionOutput) ToApiConnectionOutputWithContext ¶
func (o ApiConnectionOutput) ToApiConnectionOutputWithContext(ctx context.Context) ApiConnectionOutput
type ApiConnectionState ¶
type ApiConnectionState struct { // A display name for this API Connection. Changing this forces a new API Connection to be created. DisplayName pulumi.StringPtrInput // The ID of the Managed API which this API Connection is linked to. Changing this forces a new API Connection to be created. ManagedApiId pulumi.StringPtrInput // The Name which should be used for this API Connection. Changing this forces a new API Connection to be created. Name pulumi.StringPtrInput ParameterValues pulumi.StringMapInput // The name of the Resource Group where this API Connection should exist. Changing this forces a new API Connection to be created. ResourceGroupName pulumi.StringPtrInput // A mapping of tags which should be assigned to the API Connection. Tags pulumi.StringMapInput }
func (ApiConnectionState) ElementType ¶
func (ApiConnectionState) ElementType() reflect.Type
type GetManagedApiArgs ¶
type GetManagedApiArgs struct { // The Azure location for this Managed API. Location string `pulumi:"location"` // Specifies the name of the Managed API. Name string `pulumi:"name"` }
A collection of arguments for invoking getManagedApi.
type GetManagedApiOutputArgs ¶
type GetManagedApiOutputArgs struct { // The Azure location for this Managed API. Location pulumi.StringInput `pulumi:"location"` // Specifies the name of the Managed API. Name pulumi.StringInput `pulumi:"name"` }
A collection of arguments for invoking getManagedApi.
func (GetManagedApiOutputArgs) ElementType ¶
func (GetManagedApiOutputArgs) ElementType() reflect.Type
type GetManagedApiResult ¶
type GetManagedApiResult struct { // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` Location string `pulumi:"location"` Name string `pulumi:"name"` Tags map[string]string `pulumi:"tags"` }
A collection of values returned by getManagedApi.
func GetManagedApi ¶
func GetManagedApi(ctx *pulumi.Context, args *GetManagedApiArgs, opts ...pulumi.InvokeOption) (*GetManagedApiResult, error)
Uses this data source to access information about an existing Managed API.
## Example Usage
<!--Start PulumiCodeChooser --> ```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/connections" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { example, err := connections.GetManagedApi(ctx, &connections.GetManagedApiArgs{ Name: "servicebus", Location: "West Europe", }, nil) if err != nil { return err } ctx.Export("id", example.Id) return nil }) }
``` <!--End PulumiCodeChooser -->
type GetManagedApiResultOutput ¶
type GetManagedApiResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getManagedApi.
func GetManagedApiOutput ¶
func GetManagedApiOutput(ctx *pulumi.Context, args GetManagedApiOutputArgs, opts ...pulumi.InvokeOption) GetManagedApiResultOutput
func (GetManagedApiResultOutput) ElementType ¶
func (GetManagedApiResultOutput) ElementType() reflect.Type
func (GetManagedApiResultOutput) Id ¶
func (o GetManagedApiResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (GetManagedApiResultOutput) Location ¶
func (o GetManagedApiResultOutput) Location() pulumi.StringOutput
func (GetManagedApiResultOutput) Name ¶
func (o GetManagedApiResultOutput) Name() pulumi.StringOutput
func (GetManagedApiResultOutput) Tags ¶
func (o GetManagedApiResultOutput) Tags() pulumi.StringMapOutput
func (GetManagedApiResultOutput) ToGetManagedApiResultOutput ¶
func (o GetManagedApiResultOutput) ToGetManagedApiResultOutput() GetManagedApiResultOutput
func (GetManagedApiResultOutput) ToGetManagedApiResultOutputWithContext ¶
func (o GetManagedApiResultOutput) ToGetManagedApiResultOutputWithContext(ctx context.Context) GetManagedApiResultOutput