We recommend using Azure Native.
azure.eventgrid.PartnerConfiguration
Explore with Pulumi AI
Manages an Event Grid Partner Configuration.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const examplePartnerConfiguration = new azure.eventgrid.PartnerConfiguration("example", {
resourceGroupName: example.name,
defaultMaximumExpirationTimeInDays: 14,
partnerAuthorizations: [{
partnerRegistrationId: "804a11ca-ce9b-4158-8e94-3c8dc7a072ec",
partnerName: "Auth0",
authorizationExpirationTimeInUtc: "2025-02-05T00:00:00Z",
}],
tags: {
environment: "Production",
},
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_partner_configuration = azure.eventgrid.PartnerConfiguration("example",
resource_group_name=example.name,
default_maximum_expiration_time_in_days=14,
partner_authorizations=[{
"partner_registration_id": "804a11ca-ce9b-4158-8e94-3c8dc7a072ec",
"partner_name": "Auth0",
"authorization_expiration_time_in_utc": "2025-02-05T00:00:00Z",
}],
tags={
"environment": "Production",
})
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/eventgrid"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
_, err = eventgrid.NewPartnerConfiguration(ctx, "example", &eventgrid.PartnerConfigurationArgs{
ResourceGroupName: example.Name,
DefaultMaximumExpirationTimeInDays: pulumi.Int(14),
PartnerAuthorizations: eventgrid.PartnerConfigurationPartnerAuthorizationArray{
&eventgrid.PartnerConfigurationPartnerAuthorizationArgs{
PartnerRegistrationId: pulumi.String("804a11ca-ce9b-4158-8e94-3c8dc7a072ec"),
PartnerName: pulumi.String("Auth0"),
AuthorizationExpirationTimeInUtc: pulumi.String("2025-02-05T00:00:00Z"),
},
},
Tags: pulumi.StringMap{
"environment": pulumi.String("Production"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var examplePartnerConfiguration = new Azure.EventGrid.PartnerConfiguration("example", new()
{
ResourceGroupName = example.Name,
DefaultMaximumExpirationTimeInDays = 14,
PartnerAuthorizations = new[]
{
new Azure.EventGrid.Inputs.PartnerConfigurationPartnerAuthorizationArgs
{
PartnerRegistrationId = "804a11ca-ce9b-4158-8e94-3c8dc7a072ec",
PartnerName = "Auth0",
AuthorizationExpirationTimeInUtc = "2025-02-05T00:00:00Z",
},
},
Tags =
{
{ "environment", "Production" },
},
});
});
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.eventgrid.PartnerConfiguration;
import com.pulumi.azure.eventgrid.PartnerConfigurationArgs;
import com.pulumi.azure.eventgrid.inputs.PartnerConfigurationPartnerAuthorizationArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var examplePartnerConfiguration = new PartnerConfiguration("examplePartnerConfiguration", PartnerConfigurationArgs.builder()
.resourceGroupName(example.name())
.defaultMaximumExpirationTimeInDays(14)
.partnerAuthorizations(PartnerConfigurationPartnerAuthorizationArgs.builder()
.partnerRegistrationId("804a11ca-ce9b-4158-8e94-3c8dc7a072ec")
.partnerName("Auth0")
.authorizationExpirationTimeInUtc("2025-02-05T00:00:00Z")
.build())
.tags(Map.of("environment", "Production"))
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
examplePartnerConfiguration:
type: azure:eventgrid:PartnerConfiguration
name: example
properties:
resourceGroupName: ${example.name}
defaultMaximumExpirationTimeInDays: 14
partnerAuthorizations:
- partnerRegistrationId: 804a11ca-ce9b-4158-8e94-3c8dc7a072ec
partnerName: Auth0
authorizationExpirationTimeInUtc: 2025-02-05T00:00:00Z
tags:
environment: Production
API Providers
This resource uses the following Azure API Providers:
Microsoft.EventGrid
: 2022-06-15
Create PartnerConfiguration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PartnerConfiguration(name: string, args: PartnerConfigurationArgs, opts?: CustomResourceOptions);
@overload
def PartnerConfiguration(resource_name: str,
args: PartnerConfigurationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PartnerConfiguration(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
default_maximum_expiration_time_in_days: Optional[int] = None,
partner_authorizations: Optional[Sequence[PartnerConfigurationPartnerAuthorizationArgs]] = None,
tags: Optional[Mapping[str, str]] = None)
func NewPartnerConfiguration(ctx *Context, name string, args PartnerConfigurationArgs, opts ...ResourceOption) (*PartnerConfiguration, error)
public PartnerConfiguration(string name, PartnerConfigurationArgs args, CustomResourceOptions? opts = null)
public PartnerConfiguration(String name, PartnerConfigurationArgs args)
public PartnerConfiguration(String name, PartnerConfigurationArgs args, CustomResourceOptions options)
type: azure:eventgrid:PartnerConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args PartnerConfigurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PartnerConfigurationArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PartnerConfigurationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PartnerConfigurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PartnerConfigurationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var partnerConfigurationResource = new Azure.EventGrid.PartnerConfiguration("partnerConfigurationResource", new()
{
ResourceGroupName = "string",
DefaultMaximumExpirationTimeInDays = 0,
PartnerAuthorizations = new[]
{
new Azure.EventGrid.Inputs.PartnerConfigurationPartnerAuthorizationArgs
{
PartnerName = "string",
PartnerRegistrationId = "string",
AuthorizationExpirationTimeInUtc = "string",
},
},
Tags =
{
{ "string", "string" },
},
});
example, err := eventgrid.NewPartnerConfiguration(ctx, "partnerConfigurationResource", &eventgrid.PartnerConfigurationArgs{
ResourceGroupName: pulumi.String("string"),
DefaultMaximumExpirationTimeInDays: pulumi.Int(0),
PartnerAuthorizations: eventgrid.PartnerConfigurationPartnerAuthorizationArray{
&eventgrid.PartnerConfigurationPartnerAuthorizationArgs{
PartnerName: pulumi.String("string"),
PartnerRegistrationId: pulumi.String("string"),
AuthorizationExpirationTimeInUtc: pulumi.String("string"),
},
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var partnerConfigurationResource = new PartnerConfiguration("partnerConfigurationResource", PartnerConfigurationArgs.builder()
.resourceGroupName("string")
.defaultMaximumExpirationTimeInDays(0)
.partnerAuthorizations(PartnerConfigurationPartnerAuthorizationArgs.builder()
.partnerName("string")
.partnerRegistrationId("string")
.authorizationExpirationTimeInUtc("string")
.build())
.tags(Map.of("string", "string"))
.build());
partner_configuration_resource = azure.eventgrid.PartnerConfiguration("partnerConfigurationResource",
resource_group_name="string",
default_maximum_expiration_time_in_days=0,
partner_authorizations=[{
"partner_name": "string",
"partner_registration_id": "string",
"authorization_expiration_time_in_utc": "string",
}],
tags={
"string": "string",
})
const partnerConfigurationResource = new azure.eventgrid.PartnerConfiguration("partnerConfigurationResource", {
resourceGroupName: "string",
defaultMaximumExpirationTimeInDays: 0,
partnerAuthorizations: [{
partnerName: "string",
partnerRegistrationId: "string",
authorizationExpirationTimeInUtc: "string",
}],
tags: {
string: "string",
},
});
type: azure:eventgrid:PartnerConfiguration
properties:
defaultMaximumExpirationTimeInDays: 0
partnerAuthorizations:
- authorizationExpirationTimeInUtc: string
partnerName: string
partnerRegistrationId: string
resourceGroupName: string
tags:
string: string
PartnerConfiguration Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The PartnerConfiguration resource accepts the following input properties:
- Resource
Group stringName - The name of the Resource Group where the Event Grid Partner Configuration should exist. Changing this forces a new Event Grid Partner Configuration to be created.
- Default
Maximum intExpiration Time In Days - Time used to validate the authorization expiration time for each authorized partner. Defaults to
7
. - List<Partner
Configuration Partner Authorization> - One or more
partner_authorization
blocks as defined below. - Dictionary<string, string>
- A mapping of tags which should be assigned to the Event Grid Partner Configuration.
- Resource
Group stringName - The name of the Resource Group where the Event Grid Partner Configuration should exist. Changing this forces a new Event Grid Partner Configuration to be created.
- Default
Maximum intExpiration Time In Days - Time used to validate the authorization expiration time for each authorized partner. Defaults to
7
. - []Partner
Configuration Partner Authorization Args - One or more
partner_authorization
blocks as defined below. - map[string]string
- A mapping of tags which should be assigned to the Event Grid Partner Configuration.
- resource
Group StringName - The name of the Resource Group where the Event Grid Partner Configuration should exist. Changing this forces a new Event Grid Partner Configuration to be created.
- default
Maximum IntegerExpiration Time In Days - Time used to validate the authorization expiration time for each authorized partner. Defaults to
7
. - List<Partner
Configuration Partner Authorization> - One or more
partner_authorization
blocks as defined below. - Map<String,String>
- A mapping of tags which should be assigned to the Event Grid Partner Configuration.
- resource
Group stringName - The name of the Resource Group where the Event Grid Partner Configuration should exist. Changing this forces a new Event Grid Partner Configuration to be created.
- default
Maximum numberExpiration Time In Days - Time used to validate the authorization expiration time for each authorized partner. Defaults to
7
. - Partner
Configuration Partner Authorization[] - One or more
partner_authorization
blocks as defined below. - {[key: string]: string}
- A mapping of tags which should be assigned to the Event Grid Partner Configuration.
- resource_
group_ strname - The name of the Resource Group where the Event Grid Partner Configuration should exist. Changing this forces a new Event Grid Partner Configuration to be created.
- default_
maximum_ intexpiration_ time_ in_ days - Time used to validate the authorization expiration time for each authorized partner. Defaults to
7
. - Sequence[Partner
Configuration Partner Authorization Args] - One or more
partner_authorization
blocks as defined below. - Mapping[str, str]
- A mapping of tags which should be assigned to the Event Grid Partner Configuration.
- resource
Group StringName - The name of the Resource Group where the Event Grid Partner Configuration should exist. Changing this forces a new Event Grid Partner Configuration to be created.
- default
Maximum NumberExpiration Time In Days - Time used to validate the authorization expiration time for each authorized partner. Defaults to
7
. - List<Property Map>
- One or more
partner_authorization
blocks as defined below. - Map<String>
- A mapping of tags which should be assigned to the Event Grid Partner Configuration.
Outputs
All input properties are implicitly available as output properties. Additionally, the PartnerConfiguration resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing PartnerConfiguration Resource
Get an existing PartnerConfiguration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: PartnerConfigurationState, opts?: CustomResourceOptions): PartnerConfiguration
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
default_maximum_expiration_time_in_days: Optional[int] = None,
partner_authorizations: Optional[Sequence[PartnerConfigurationPartnerAuthorizationArgs]] = None,
resource_group_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None) -> PartnerConfiguration
func GetPartnerConfiguration(ctx *Context, name string, id IDInput, state *PartnerConfigurationState, opts ...ResourceOption) (*PartnerConfiguration, error)
public static PartnerConfiguration Get(string name, Input<string> id, PartnerConfigurationState? state, CustomResourceOptions? opts = null)
public static PartnerConfiguration get(String name, Output<String> id, PartnerConfigurationState state, CustomResourceOptions options)
resources: _: type: azure:eventgrid:PartnerConfiguration get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Default
Maximum intExpiration Time In Days - Time used to validate the authorization expiration time for each authorized partner. Defaults to
7
. - List<Partner
Configuration Partner Authorization> - One or more
partner_authorization
blocks as defined below. - Resource
Group stringName - The name of the Resource Group where the Event Grid Partner Configuration should exist. Changing this forces a new Event Grid Partner Configuration to be created.
- Dictionary<string, string>
- A mapping of tags which should be assigned to the Event Grid Partner Configuration.
- Default
Maximum intExpiration Time In Days - Time used to validate the authorization expiration time for each authorized partner. Defaults to
7
. - []Partner
Configuration Partner Authorization Args - One or more
partner_authorization
blocks as defined below. - Resource
Group stringName - The name of the Resource Group where the Event Grid Partner Configuration should exist. Changing this forces a new Event Grid Partner Configuration to be created.
- map[string]string
- A mapping of tags which should be assigned to the Event Grid Partner Configuration.
- default
Maximum IntegerExpiration Time In Days - Time used to validate the authorization expiration time for each authorized partner. Defaults to
7
. - List<Partner
Configuration Partner Authorization> - One or more
partner_authorization
blocks as defined below. - resource
Group StringName - The name of the Resource Group where the Event Grid Partner Configuration should exist. Changing this forces a new Event Grid Partner Configuration to be created.
- Map<String,String>
- A mapping of tags which should be assigned to the Event Grid Partner Configuration.
- default
Maximum numberExpiration Time In Days - Time used to validate the authorization expiration time for each authorized partner. Defaults to
7
. - Partner
Configuration Partner Authorization[] - One or more
partner_authorization
blocks as defined below. - resource
Group stringName - The name of the Resource Group where the Event Grid Partner Configuration should exist. Changing this forces a new Event Grid Partner Configuration to be created.
- {[key: string]: string}
- A mapping of tags which should be assigned to the Event Grid Partner Configuration.
- default_
maximum_ intexpiration_ time_ in_ days - Time used to validate the authorization expiration time for each authorized partner. Defaults to
7
. - Sequence[Partner
Configuration Partner Authorization Args] - One or more
partner_authorization
blocks as defined below. - resource_
group_ strname - The name of the Resource Group where the Event Grid Partner Configuration should exist. Changing this forces a new Event Grid Partner Configuration to be created.
- Mapping[str, str]
- A mapping of tags which should be assigned to the Event Grid Partner Configuration.
- default
Maximum NumberExpiration Time In Days - Time used to validate the authorization expiration time for each authorized partner. Defaults to
7
. - List<Property Map>
- One or more
partner_authorization
blocks as defined below. - resource
Group StringName - The name of the Resource Group where the Event Grid Partner Configuration should exist. Changing this forces a new Event Grid Partner Configuration to be created.
- Map<String>
- A mapping of tags which should be assigned to the Event Grid Partner Configuration.
Supporting Types
PartnerConfigurationPartnerAuthorization, PartnerConfigurationPartnerAuthorizationArgs
- Partner
Name string - The partner name.
- Partner
Registration stringId - The immutable id of the corresponding partner registration.
- string
Expiration time of the partner authorization. Value should be in RFC 3339 format in UTC time zone, for example: "2025-02-04T00:00:00Z".
Note: If the time from
authorization_expiration_time_in_utc
expires, any request from this partner to create, update or delete resources in the subscriber's context will fail. If not specified, the authorization will expire afterdefault_maximum_expiration_time_in_days
.
- Partner
Name string - The partner name.
- Partner
Registration stringId - The immutable id of the corresponding partner registration.
- string
Expiration time of the partner authorization. Value should be in RFC 3339 format in UTC time zone, for example: "2025-02-04T00:00:00Z".
Note: If the time from
authorization_expiration_time_in_utc
expires, any request from this partner to create, update or delete resources in the subscriber's context will fail. If not specified, the authorization will expire afterdefault_maximum_expiration_time_in_days
.
- partner
Name String - The partner name.
- partner
Registration StringId - The immutable id of the corresponding partner registration.
- String
Expiration time of the partner authorization. Value should be in RFC 3339 format in UTC time zone, for example: "2025-02-04T00:00:00Z".
Note: If the time from
authorization_expiration_time_in_utc
expires, any request from this partner to create, update or delete resources in the subscriber's context will fail. If not specified, the authorization will expire afterdefault_maximum_expiration_time_in_days
.
- partner
Name string - The partner name.
- partner
Registration stringId - The immutable id of the corresponding partner registration.
- string
Expiration time of the partner authorization. Value should be in RFC 3339 format in UTC time zone, for example: "2025-02-04T00:00:00Z".
Note: If the time from
authorization_expiration_time_in_utc
expires, any request from this partner to create, update or delete resources in the subscriber's context will fail. If not specified, the authorization will expire afterdefault_maximum_expiration_time_in_days
.
- partner_
name str - The partner name.
- partner_
registration_ strid - The immutable id of the corresponding partner registration.
- str
Expiration time of the partner authorization. Value should be in RFC 3339 format in UTC time zone, for example: "2025-02-04T00:00:00Z".
Note: If the time from
authorization_expiration_time_in_utc
expires, any request from this partner to create, update or delete resources in the subscriber's context will fail. If not specified, the authorization will expire afterdefault_maximum_expiration_time_in_days
.
- partner
Name String - The partner name.
- partner
Registration StringId - The immutable id of the corresponding partner registration.
- String
Expiration time of the partner authorization. Value should be in RFC 3339 format in UTC time zone, for example: "2025-02-04T00:00:00Z".
Note: If the time from
authorization_expiration_time_in_utc
expires, any request from this partner to create, update or delete resources in the subscriber's context will fail. If not specified, the authorization will expire afterdefault_maximum_expiration_time_in_days
.
Import
Event Grid Partner Configurations can be imported using the resource id
, e.g.
$ pulumi import azure:eventgrid/partnerConfiguration:PartnerConfiguration example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.