List SAS credentials of a storage account.
Uses Azure REST API version 2024-01-01.
Other available API versions: 2022-09-01, 2023-01-01, 2023-04-01, 2023-05-01, 2025-01-01, 2025-06-01, 2025-08-01, 2026-04-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native storage [ApiVersion]. See the version guide for details.
Using listStorageAccountSAS
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.
def list_storage_account_sas(account_name: Optional[str] = None,
i_p_address_or_range: Optional[str] = None,
key_to_sign: Optional[str] = None,
permissions: Optional[Union[str, Permissions]] = None,
protocols: Optional[HttpProtocol] = None,
resource_group_name: Optional[str] = None,
resource_types: Optional[Union[str, SignedResourceTypes]] = None,
services: Optional[Union[str, Services]] = None,
shared_access_expiry_time: Optional[str] = None,
shared_access_start_time: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> ListStorageAccountSASResult
def list_storage_account_sas_output(account_name: pulumi.Input[Optional[str]] = None,
i_p_address_or_range: pulumi.Input[Optional[str]] = None,
key_to_sign: pulumi.Input[Optional[str]] = None,
permissions: pulumi.Input[Optional[Union[str, Permissions]]] = None,
protocols: pulumi.Input[Optional[HttpProtocol]] = None,
resource_group_name: pulumi.Input[Optional[str]] = None,
resource_types: pulumi.Input[Optional[Union[str, SignedResourceTypes]]] = None,
services: pulumi.Input[Optional[Union[str, Services]]] = None,
shared_access_expiry_time: pulumi.Input[Optional[str]] = None,
shared_access_start_time: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[ListStorageAccountSASResult]
> Note: This function is named ListStorageAccountSAS in the Go SDK.
fn::invoke:
function: azure-native:storage:listStorageAccountSAS
arguments:
# arguments dictionary
data "azure-native_storage_list_storage_account_s_a_s" "name" {
# arguments
}
The following arguments are supported:
- AccountName
string
- The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- Permissions
string | Pulumi.AzureNative.Storage.Permissions
- The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p).
- ResourceGroupName
string
- The name of the resource group within the user's subscription. The name is case insensitive.
- ResourceTypes
string | Pulumi.AzureNative.Storage.SignedResourceTypes
- The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files.
- Services
string | Pulumi.AzureNative.Storage.Services
- The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f).
- SharedAccessExpiryTime
string
- The time at which the shared access signature becomes invalid.
- IPAddressOrRange
string
- An IP address or a range of IP addresses from which to accept requests.
- KeyToSign
string
- The key to sign the account SAS token with.
- Protocols
Pulumi.AzureNative.Storage.HttpProtocol
- The protocol permitted for a request made with the account SAS.
- SharedAccessStartTime
string
- The time at which the SAS becomes valid.
- AccountName
string
- The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- Permissions
string | Permissions
- The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p).
- ResourceGroupName
string
- The name of the resource group within the user's subscription. The name is case insensitive.
- ResourceTypes
string | SignedResourceTypes
- The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files.
- Services
string | Services
- The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f).
- SharedAccessExpiryTime
string
- The time at which the shared access signature becomes invalid.
- IPAddressOrRange
string
- An IP address or a range of IP addresses from which to accept requests.
- KeyToSign
string
- The key to sign the account SAS token with.
- Protocols
HttpProtocol
- The protocol permitted for a request made with the account SAS.
- SharedAccessStartTime
string
- The time at which the SAS becomes valid.
- account_name
string
- The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- permissions
string | "r" | "d" | "w" | "l" | "a" | "c" | "u" | "p"
- The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p).
- resource_group_name
string
- The name of the resource group within the user's subscription. The name is case insensitive.
- resource_types
string | "s" | "c" | "o"
- The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files.
- services
string | "b" | "q" | "t" | "f"
- The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f).
- shared_access_expiry_time
string
- The time at which the shared access signature becomes invalid.
- i_p_address_or_range
string
- An IP address or a range of IP addresses from which to accept requests.
- key_to_sign
string
- The key to sign the account SAS token with.
- protocols
"https,http" | "https"
- The protocol permitted for a request made with the account SAS.
- shared_access_start_time
string
- The time at which the SAS becomes valid.
- accountName
String
- The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- permissions
String | Permissions
- The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p).
- resourceGroupName
String
- The name of the resource group within the user's subscription. The name is case insensitive.
- resourceTypes
String | SignedResourceTypes
- The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files.
- services
String | Services
- The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f).
- sharedAccessExpiryTime
String
- The time at which the shared access signature becomes invalid.
- iPAddressOrRange
String
- An IP address or a range of IP addresses from which to accept requests.
- keyToSign
String
- The key to sign the account SAS token with.
- protocols
HttpProtocol
- The protocol permitted for a request made with the account SAS.
- sharedAccessStartTime
String
- The time at which the SAS becomes valid.
- accountName
string
- The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- permissions
string | Permissions
- The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p).
- resourceGroupName
string
- The name of the resource group within the user's subscription. The name is case insensitive.
- resourceTypes
string | SignedResourceTypes
- The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files.
- services
string | Services
- The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f).
- sharedAccessExpiryTime
string
- The time at which the shared access signature becomes invalid.
- iPAddressOrRange
string
- An IP address or a range of IP addresses from which to accept requests.
- keyToSign
string
- The key to sign the account SAS token with.
- protocols
HttpProtocol
- The protocol permitted for a request made with the account SAS.
- sharedAccessStartTime
string
- The time at which the SAS becomes valid.
- account_name
str
- The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- permissions
str | Permissions
- The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p).
- resource_group_name
str
- The name of the resource group within the user's subscription. The name is case insensitive.
- resource_types
str | SignedResourceTypes
- The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files.
- services
str | Services
- The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f).
- shared_access_expiry_time
str
- The time at which the shared access signature becomes invalid.
- i_p_address_or_range
str
- An IP address or a range of IP addresses from which to accept requests.
- key_to_sign
str
- The key to sign the account SAS token with.
- protocols
HttpProtocol
- The protocol permitted for a request made with the account SAS.
- shared_access_start_time
str
- The time at which the SAS becomes valid.
- accountName
String
- The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- permissions
String | "r" | "d" | "w" | "l" | "a" | "c" | "u" | "p"
- The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p).
- resourceGroupName
String
- The name of the resource group within the user's subscription. The name is case insensitive.
- resourceTypes
String | "s" | "c" | "o"
- The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files.
- services
String | "b" | "q" | "t" | "f"
- The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f).
- sharedAccessExpiryTime
String
- The time at which the shared access signature becomes invalid.
- iPAddressOrRange
String
- An IP address or a range of IP addresses from which to accept requests.
- keyToSign
String
- The key to sign the account SAS token with.
- protocols
"https,http" | "https"
- The protocol permitted for a request made with the account SAS.
- sharedAccessStartTime
String
- The time at which the SAS becomes valid.
listStorageAccountSAS Result
The following output properties are available:
Supporting Types
HttpProtocol
| Name | Value |
|---|
| Https_http | https,http |
| Https | https |
| Name | Value |
|---|
| HttpProtocol_Https_http | https,http |
| HttpProtocolHttps | https |
| Name | Value |
|---|
| Https_http | https,http |
| Https | https |
| Name | Value |
|---|
| Https_http | https,http |
| Https | https |
| Name | Value |
|---|
| HTTPS_HTTP | https,http |
| HTTPS | https |
Permissions
| Name | Value |
|---|
| R | r |
| D | d |
| W | w |
| L | l |
| A | a |
| C | c |
| U | u |
| P | p |
| Name | Value |
|---|
| PermissionsR | r |
| PermissionsD | d |
| PermissionsW | w |
| PermissionsL | l |
| PermissionsA | a |
| PermissionsC | c |
| PermissionsU | u |
| PermissionsP | p |
| Name | Value |
|---|
| R | r |
| D | d |
| W | w |
| L | l |
| A | a |
| C | c |
| U | u |
| P | p |
| Name | Value |
|---|
| R | r |
| D | d |
| W | w |
| L | l |
| A | a |
| C | c |
| U | u |
| P | p |
| Name | Value |
|---|
| R | r |
| D | d |
| W | w |
| L | l |
| A | a |
| C | c |
| U | u |
| P | p |
Services
| Name | Value |
|---|
| ServicesB | b |
| ServicesQ | q |
| ServicesT | t |
| ServicesF | f |
SignedResourceTypes
| Name | Value |
|---|
| SignedResourceTypesS | s |
| SignedResourceTypesC | c |
| SignedResourceTypesO | o |
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0