Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. apimanagement
  5. getUserSharedAccessToken
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.apimanagement.getUserSharedAccessToken

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 the Shared Access Authorization Token for the User. Azure REST API version: 2022-08-01.

Other available API versions: 2016-10-10, 2017-03-01, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.

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>
Copy
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]
Copy
func GetUserSharedAccessToken(ctx *Context, args *GetUserSharedAccessTokenArgs, opts ...InvokeOption) (*GetUserSharedAccessTokenResult, error)
func GetUserSharedAccessTokenOutput(ctx *Context, args *GetUserSharedAccessTokenOutputArgs, opts ...InvokeOption) GetUserSharedAccessTokenResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetUserSharedAccessTokenResult> getUserSharedAccessToken(GetUserSharedAccessTokenArgs args, InvokeOptions options)
public static Output<GetUserSharedAccessTokenResult> getUserSharedAccessToken(GetUserSharedAccessTokenArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apimanagement:getUserSharedAccessToken
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Expiry This property is required. 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 This property is required. Pulumi.AzureNative.ApiManagement.KeyType
The Key to be used to generate token for user.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
UserId
This property is required.
Changes to this property will trigger replacement.
string
User identifier. Must be unique in the current API Management service instance.
Expiry This property is required. 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 This property is required. KeyType
The Key to be used to generate token for user.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
UserId
This property is required.
Changes to this property will trigger replacement.
string
User identifier. Must be unique in the current API Management service instance.
expiry This property is required. 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 This property is required. KeyType
The Key to be used to generate token for user.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
userId
This property is required.
Changes to this property will trigger replacement.
String
User identifier. Must be unique in the current API Management service instance.
expiry This property is required. 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 This property is required. KeyType
The Key to be used to generate token for user.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
userId
This property is required.
Changes to this property will trigger replacement.
string
User identifier. Must be unique in the current API Management service instance.
expiry This property is required. 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 This property is required. KeyType
The Key to be used to generate token for user.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
user_id
This property is required.
Changes to this property will trigger replacement.
str
User identifier. Must be unique in the current API Management service instance.
expiry This property is required. 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 This property is required. "primary" | "secondary"
The Key to be used to generate token for user.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
userId
This property is required.
Changes to this property will trigger replacement.
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-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