1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. listGatewayDebugCredentials
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.apimanagement.listGatewayDebugCredentials

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    Create new debug credentials for gateway. Azure REST API version: 2023-03-01-preview.

    Other available API versions: 2023-05-01-preview, 2023-09-01-preview, 2024-05-01.

    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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:apimanagement:listGatewayDebugCredentials
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ApiId string
    Full resource Id of an API.
    GatewayId string
    Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
    Purposes List<Union<string, Pulumi.AzureNative.ApiManagement.GatewayListDebugCredentialsContractPurpose>>
    Purposes of debug credential.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    CredentialsExpireAfter string
    Credentials expiration in ISO8601 format. Maximum duration of the credentials is PT1H. When property is not specified, them value PT1H is used.
    ApiId string
    Full resource Id of an API.
    GatewayId 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.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    CredentialsExpireAfter string
    Credentials expiration in ISO8601 format. Maximum duration of the credentials is PT1H. When property is not specified, them value PT1H is used.
    apiId String
    Full resource Id of an API.
    gatewayId String
    Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
    purposes List<Either<String,GatewayListDebugCredentialsContractPurpose>>
    Purposes of debug credential.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    credentialsExpireAfter String
    Credentials expiration in ISO8601 format. Maximum duration of the credentials is PT1H. When property is not specified, them value PT1H is used.
    apiId string
    Full resource Id of an API.
    gatewayId string
    Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
    purposes (string | GatewayListDebugCredentialsContractPurpose)[]
    Purposes of debug credential.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of the API Management service.
    credentialsExpireAfter string
    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, GatewayListDebugCredentialsContractPurpose]]
    Purposes of debug credential.
    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.
    credentials_expire_after str
    Credentials expiration in ISO8601 format. Maximum duration of the credentials is PT1H. When property is not specified, them value PT1H is used.
    apiId String
    Full resource Id of an API.
    gatewayId 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.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    credentialsExpireAfter String
    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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi