Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. getUserSharedAccessToken
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.getUserSharedAccessToken

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets the Shared Access Authorization Token for the User.

    Uses Azure REST API version 2022-09-01-preview.

    Other available API versions: 2021-04-01-preview, 2021-08-01, 2021-12-01-preview, 2022-04-01-preview, 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the version guide for details.

    Using getUserSharedAccessToken

    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 getUserSharedAccessToken(args: GetUserSharedAccessTokenArgs, opts?: InvokeOptions): Promise<GetUserSharedAccessTokenResult>
function getUserSharedAccessTokenOutput(args: GetUserSharedAccessTokenOutputArgs, opts?: InvokeOptions): Output<GetUserSharedAccessTokenResult>
    def get_user_shared_access_token(expiry: Optional[str] = None,
                                 key_type: Optional[KeyType] = None,
                                 resource_group_name: Optional[str] = None,
                                 service_name: Optional[str] = None,
                                 user_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetUserSharedAccessTokenResult
def get_user_shared_access_token_output(expiry: Optional[pulumi.Input[str]] = None,
                                 key_type: Optional[pulumi.Input[KeyType]] = None,
                                 resource_group_name: Optional[pulumi.Input[str]] = None,
                                 service_name: Optional[pulumi.Input[str]] = None,
                                 user_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetUserSharedAccessTokenResult]
    func GetUserSharedAccessToken(ctx *Context, args *GetUserSharedAccessTokenArgs, opts ...InvokeOption) (*GetUserSharedAccessTokenResult, error)
func GetUserSharedAccessTokenOutput(ctx *Context, args *GetUserSharedAccessTokenOutputArgs, opts ...InvokeOption) GetUserSharedAccessTokenResultOutput

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

    public static class GetUserSharedAccessToken 
{
    public static Task<GetUserSharedAccessTokenResult> InvokeAsync(GetUserSharedAccessTokenArgs args, InvokeOptions? opts = null)
    public static Output<GetUserSharedAccessTokenResult> Invoke(GetUserSharedAccessTokenInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetUserSharedAccessTokenResult> getUserSharedAccessToken(GetUserSharedAccessTokenArgs args, InvokeOptions options)
public static Output<GetUserSharedAccessTokenResult> getUserSharedAccessToken(GetUserSharedAccessTokenArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:apimanagement:getUserSharedAccessToken
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Expiry string
    The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    KeyType Pulumi.AzureNative.ApiManagement.KeyType
    The Key to be used to generate token for user.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    UserId string
    User identifier. Must be unique in the current API Management service instance.
    Expiry string
    The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    KeyType KeyType
    The Key to be used to generate token for user.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    UserId string
    User identifier. Must be unique in the current API Management service instance.
    expiry String
    The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    keyType KeyType
    The Key to be used to generate token for user.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    userId String
    User identifier. Must be unique in the current API Management service instance.
    expiry string
    The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    keyType KeyType
    The Key to be used to generate token for user.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of the API Management service.
    userId string
    User identifier. Must be unique in the current API Management service instance.
    expiry str
    The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    key_type KeyType
    The Key to be used to generate token for user.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    service_name str
    The name of the API Management service.
    user_id str
    User identifier. Must be unique in the current API Management service instance.
    expiry String
    The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    keyType "primary" | "secondary"
    The Key to be used to generate token for user.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    userId String
    User identifier. Must be unique in the current API Management service instance.

    getUserSharedAccessToken Result

    The following output properties are available:

    Value string
    Shared Access Authorization token for the User.
    Value string
    Shared Access Authorization token for the User.
    value String
    Shared Access Authorization token for the User.
    value string
    Shared Access Authorization token for the User.
    value str
    Shared Access Authorization token for the User.
    value String
    Shared Access Authorization token for the User.

    Supporting Types

    KeyType

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native