azure-native.apimanagement.listGatewayDebugCredentials
Explore with Pulumi AI
Create new debug credentials for gateway.
Uses Azure REST API version 2024-06-01-preview.
Other available API versions: 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01. 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 listGatewayDebugCredentials
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 listGatewayDebugCredentials(args: ListGatewayDebugCredentialsArgs, opts?: InvokeOptions): Promise<ListGatewayDebugCredentialsResult>
function listGatewayDebugCredentialsOutput(args: ListGatewayDebugCredentialsOutputArgs, opts?: InvokeOptions): Output<ListGatewayDebugCredentialsResult>def list_gateway_debug_credentials(api_id: Optional[str] = None,
                                   credentials_expire_after: Optional[str] = None,
                                   gateway_id: Optional[str] = None,
                                   purposes: Optional[Sequence[Union[str, GatewayListDebugCredentialsContractPurpose]]] = None,
                                   resource_group_name: Optional[str] = None,
                                   service_name: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> ListGatewayDebugCredentialsResult
def list_gateway_debug_credentials_output(api_id: Optional[pulumi.Input[str]] = None,
                                   credentials_expire_after: Optional[pulumi.Input[str]] = None,
                                   gateway_id: Optional[pulumi.Input[str]] = None,
                                   purposes: Optional[pulumi.Input[Sequence[pulumi.Input[Union[str, GatewayListDebugCredentialsContractPurpose]]]]] = None,
                                   resource_group_name: Optional[pulumi.Input[str]] = None,
                                   service_name: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[ListGatewayDebugCredentialsResult]func ListGatewayDebugCredentials(ctx *Context, args *ListGatewayDebugCredentialsArgs, opts ...InvokeOption) (*ListGatewayDebugCredentialsResult, error)
func ListGatewayDebugCredentialsOutput(ctx *Context, args *ListGatewayDebugCredentialsOutputArgs, opts ...InvokeOption) ListGatewayDebugCredentialsResultOutput> Note: This function is named ListGatewayDebugCredentials in the Go SDK.
public static class ListGatewayDebugCredentials 
{
    public static Task<ListGatewayDebugCredentialsResult> InvokeAsync(ListGatewayDebugCredentialsArgs args, InvokeOptions? opts = null)
    public static Output<ListGatewayDebugCredentialsResult> Invoke(ListGatewayDebugCredentialsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<ListGatewayDebugCredentialsResult> listGatewayDebugCredentials(ListGatewayDebugCredentialsArgs args, InvokeOptions options)
public static Output<ListGatewayDebugCredentialsResult> listGatewayDebugCredentials(ListGatewayDebugCredentialsArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:apimanagement:listGatewayDebugCredentials
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Api
Id string - Full resource Id of an API.
 - Gateway
Id string - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
 - Purposes
List<Union<string, Pulumi.
Azure Native. Api Management. Gateway List Debug Credentials Contract Purpose>>  - Purposes of debug credential.
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 - Service
Name string - The name of the API Management service.
 - Credentials
Expire stringAfter  - Credentials expiration in ISO8601 format. Maximum duration of the credentials is PT1H. When property is not specified, them value PT1H is used.
 
- Api
Id string - Full resource Id of an API.
 - Gateway
Id string - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
 - Purposes []string
 - Purposes of debug credential.
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 - Service
Name string - The name of the API Management service.
 - Credentials
Expire stringAfter  - Credentials expiration in ISO8601 format. Maximum duration of the credentials is PT1H. When property is not specified, them value PT1H is used.
 
- api
Id String - Full resource Id of an API.
 - gateway
Id String - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
 - purposes
List<Either<String,Gateway
List Debug Credentials Contract Purpose>>  - Purposes of debug credential.
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 - service
Name String - The name of the API Management service.
 - credentials
Expire StringAfter  - Credentials expiration in ISO8601 format. Maximum duration of the credentials is PT1H. When property is not specified, them value PT1H is used.
 
- api
Id string - Full resource Id of an API.
 - gateway
Id string - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
 - purposes
(string | Gateway
List Debug Credentials Contract Purpose)[]  - Purposes of debug credential.
 - resource
Group stringName  - The name of the resource group. The name is case insensitive.
 - service
Name string - The name of the API Management service.
 - credentials
Expire stringAfter  - Credentials expiration in ISO8601 format. Maximum duration of the credentials is PT1H. When property is not specified, them value PT1H is used.
 
- api_
id str - Full resource Id of an API.
 - gateway_
id str - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
 - purposes
Sequence[Union[str, Gateway
List Debug Credentials Contract Purpose]]  - Purposes of debug credential.
 - resource_
group_ strname  - The name of the resource group. The name is case insensitive.
 - service_
name str - The name of the API Management service.
 - credentials_
expire_ strafter  - Credentials expiration in ISO8601 format. Maximum duration of the credentials is PT1H. When property is not specified, them value PT1H is used.
 
- api
Id String - Full resource Id of an API.
 - gateway
Id String - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
 - purposes List<String | "tracing">
 - Purposes of debug credential.
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 - service
Name String - The name of the API Management service.
 - credentials
Expire StringAfter  - Credentials expiration in ISO8601 format. Maximum duration of the credentials is PT1H. When property is not specified, them value PT1H is used.
 
listGatewayDebugCredentials Result
The following output properties are available:
- Token string
 - Gateway debug token.
 
- Token string
 - Gateway debug token.
 
- token String
 - Gateway debug token.
 
- token string
 - Gateway debug token.
 
- token str
 - Gateway debug token.
 
- token String
 - Gateway debug token.
 
Supporting Types
GatewayListDebugCredentialsContractPurpose     
Package Details
- Repository
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0