Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. azureactivedirectory
  5. getGuestUsage
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.azureactivedirectory.getGuestUsage

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider Azure REST API version: 2021-04-01.

Other available API versions: 2023-01-18-preview, 2023-05-17-preview.

Using getGuestUsage

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGuestUsage(args: GetGuestUsageArgs, opts?: InvokeOptions): Promise<GetGuestUsageResult>
function getGuestUsageOutput(args: GetGuestUsageOutputArgs, opts?: InvokeOptions): Output<GetGuestUsageResult>
Copy
def get_guest_usage(resource_group_name: Optional[str] = None,
                    resource_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetGuestUsageResult
def get_guest_usage_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                    resource_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetGuestUsageResult]
Copy
func LookupGuestUsage(ctx *Context, args *LookupGuestUsageArgs, opts ...InvokeOption) (*LookupGuestUsageResult, error)
func LookupGuestUsageOutput(ctx *Context, args *LookupGuestUsageOutputArgs, opts ...InvokeOption) LookupGuestUsageResultOutput
Copy

> Note: This function is named LookupGuestUsage in the Go SDK.

public static class GetGuestUsage 
{
    public static Task<GetGuestUsageResult> InvokeAsync(GetGuestUsageArgs args, InvokeOptions? opts = null)
    public static Output<GetGuestUsageResult> Invoke(GetGuestUsageInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGuestUsageResult> getGuestUsage(GetGuestUsageArgs args, InvokeOptions options)
public static Output<GetGuestUsageResult> getGuestUsage(GetGuestUsageArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:azureactivedirectory:getGuestUsage
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The initial domain name of the Azure AD B2C tenant.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The initial domain name of the Azure AD B2C tenant.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The initial domain name of the Azure AD B2C tenant.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
resourceName
This property is required.
Changes to this property will trigger replacement.
string
The initial domain name of the Azure AD B2C tenant.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
resource_name
This property is required.
Changes to this property will trigger replacement.
str
The initial domain name of the Azure AD B2C tenant.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The initial domain name of the Azure AD B2C tenant.

getGuestUsage Result

The following output properties are available:

Id string
An identifier that represents the Guest Usages resource.
Name string
The name of the Guest Usages resource.
SystemData Pulumi.AzureNative.AzureActiveDirectory.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the Guest Usages resource.
Location string
Location of the Guest Usages resource.
Tags Dictionary<string, string>
Key-value pairs of additional resource provisioning properties.
TenantId string
An identifier for the tenant for which the resource is being created
Id string
An identifier that represents the Guest Usages resource.
Name string
The name of the Guest Usages resource.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the Guest Usages resource.
Location string
Location of the Guest Usages resource.
Tags map[string]string
Key-value pairs of additional resource provisioning properties.
TenantId string
An identifier for the tenant for which the resource is being created
id String
An identifier that represents the Guest Usages resource.
name String
The name of the Guest Usages resource.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The type of the Guest Usages resource.
location String
Location of the Guest Usages resource.
tags Map<String,String>
Key-value pairs of additional resource provisioning properties.
tenantId String
An identifier for the tenant for which the resource is being created
id string
An identifier that represents the Guest Usages resource.
name string
The name of the Guest Usages resource.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The type of the Guest Usages resource.
location string
Location of the Guest Usages resource.
tags {[key: string]: string}
Key-value pairs of additional resource provisioning properties.
tenantId string
An identifier for the tenant for which the resource is being created
id str
An identifier that represents the Guest Usages resource.
name str
The name of the Guest Usages resource.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The type of the Guest Usages resource.
location str
Location of the Guest Usages resource.
tags Mapping[str, str]
Key-value pairs of additional resource provisioning properties.
tenant_id str
An identifier for the tenant for which the resource is being created
id String
An identifier that represents the Guest Usages resource.
name String
The name of the Guest Usages resource.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The type of the Guest Usages resource.
location String
Location of the Guest Usages resource.
tags Map<String>
Key-value pairs of additional resource provisioning properties.
tenantId String
An identifier for the tenant for which the resource is being created

Supporting Types

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native