1. Packages
  2. Azure Native
  3. API Docs
  4. customproviders
  5. getCustomResourceProvider
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.20.1 published on Friday, Dec 1, 2023 by Pulumi

azure-native.customproviders.getCustomResourceProvider

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.20.1 published on Friday, Dec 1, 2023 by Pulumi

    Gets the custom resource provider manifest. Azure REST API version: 2018-09-01-preview.

    Using getCustomResourceProvider

    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 getCustomResourceProvider(args: GetCustomResourceProviderArgs, opts?: InvokeOptions): Promise<GetCustomResourceProviderResult>
    function getCustomResourceProviderOutput(args: GetCustomResourceProviderOutputArgs, opts?: InvokeOptions): Output<GetCustomResourceProviderResult>
    def get_custom_resource_provider(resource_group_name: Optional[str] = None,
                                     resource_provider_name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetCustomResourceProviderResult
    def get_custom_resource_provider_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                     resource_provider_name: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetCustomResourceProviderResult]
    func LookupCustomResourceProvider(ctx *Context, args *LookupCustomResourceProviderArgs, opts ...InvokeOption) (*LookupCustomResourceProviderResult, error)
    func LookupCustomResourceProviderOutput(ctx *Context, args *LookupCustomResourceProviderOutputArgs, opts ...InvokeOption) LookupCustomResourceProviderResultOutput

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

    public static class GetCustomResourceProvider 
    {
        public static Task<GetCustomResourceProviderResult> InvokeAsync(GetCustomResourceProviderArgs args, InvokeOptions? opts = null)
        public static Output<GetCustomResourceProviderResult> Invoke(GetCustomResourceProviderInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCustomResourceProviderResult> getCustomResourceProvider(GetCustomResourceProviderArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:customproviders:getCustomResourceProvider
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string

    The name of the resource group.

    ResourceProviderName string

    The name of the resource provider.

    ResourceGroupName string

    The name of the resource group.

    ResourceProviderName string

    The name of the resource provider.

    resourceGroupName String

    The name of the resource group.

    resourceProviderName String

    The name of the resource provider.

    resourceGroupName string

    The name of the resource group.

    resourceProviderName string

    The name of the resource provider.

    resource_group_name str

    The name of the resource group.

    resource_provider_name str

    The name of the resource provider.

    resourceGroupName String

    The name of the resource group.

    resourceProviderName String

    The name of the resource provider.

    getCustomResourceProvider Result

    The following output properties are available:

    Id string

    Resource Id

    Location string

    Resource location

    Name string

    Resource name

    ProvisioningState string

    The provisioning state of the resource provider.

    Type string

    Resource type

    Actions List<Pulumi.AzureNative.CustomProviders.Outputs.CustomRPActionRouteDefinitionResponse>

    A list of actions that the custom resource provider implements.

    ResourceTypes List<Pulumi.AzureNative.CustomProviders.Outputs.CustomRPResourceTypeRouteDefinitionResponse>

    A list of resource types that the custom resource provider implements.

    Tags Dictionary<string, string>

    Resource tags

    Validations List<Pulumi.AzureNative.CustomProviders.Outputs.CustomRPValidationsResponse>

    A list of validations to run on the custom resource provider's requests.

    Id string

    Resource Id

    Location string

    Resource location

    Name string

    Resource name

    ProvisioningState string

    The provisioning state of the resource provider.

    Type string

    Resource type

    Actions []CustomRPActionRouteDefinitionResponse

    A list of actions that the custom resource provider implements.

    ResourceTypes []CustomRPResourceTypeRouteDefinitionResponse

    A list of resource types that the custom resource provider implements.

    Tags map[string]string

    Resource tags

    Validations []CustomRPValidationsResponse

    A list of validations to run on the custom resource provider's requests.

    id String

    Resource Id

    location String

    Resource location

    name String

    Resource name

    provisioningState String

    The provisioning state of the resource provider.

    type String

    Resource type

    actions List<CustomRPActionRouteDefinitionResponse>

    A list of actions that the custom resource provider implements.

    resourceTypes List<CustomRPResourceTypeRouteDefinitionResponse>

    A list of resource types that the custom resource provider implements.

    tags Map<String,String>

    Resource tags

    validations List<CustomRPValidationsResponse>

    A list of validations to run on the custom resource provider's requests.

    id string

    Resource Id

    location string

    Resource location

    name string

    Resource name

    provisioningState string

    The provisioning state of the resource provider.

    type string

    Resource type

    actions CustomRPActionRouteDefinitionResponse[]

    A list of actions that the custom resource provider implements.

    resourceTypes CustomRPResourceTypeRouteDefinitionResponse[]

    A list of resource types that the custom resource provider implements.

    tags {[key: string]: string}

    Resource tags

    validations CustomRPValidationsResponse[]

    A list of validations to run on the custom resource provider's requests.

    id str

    Resource Id

    location str

    Resource location

    name str

    Resource name

    provisioning_state str

    The provisioning state of the resource provider.

    type str

    Resource type

    actions Sequence[CustomRPActionRouteDefinitionResponse]

    A list of actions that the custom resource provider implements.

    resource_types Sequence[CustomRPResourceTypeRouteDefinitionResponse]

    A list of resource types that the custom resource provider implements.

    tags Mapping[str, str]

    Resource tags

    validations Sequence[CustomRPValidationsResponse]

    A list of validations to run on the custom resource provider's requests.

    id String

    Resource Id

    location String

    Resource location

    name String

    Resource name

    provisioningState String

    The provisioning state of the resource provider.

    type String

    Resource type

    actions List<Property Map>

    A list of actions that the custom resource provider implements.

    resourceTypes List<Property Map>

    A list of resource types that the custom resource provider implements.

    tags Map<String>

    Resource tags

    validations List<Property Map>

    A list of validations to run on the custom resource provider's requests.

    Supporting Types

    CustomRPActionRouteDefinitionResponse

    Endpoint string

    The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}')

    Name string

    The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')

    RoutingType string

    The routing types that are supported for action requests.

    Endpoint string

    The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}')

    Name string

    The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')

    RoutingType string

    The routing types that are supported for action requests.

    endpoint String

    The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}')

    name String

    The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')

    routingType String

    The routing types that are supported for action requests.

    endpoint string

    The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}')

    name string

    The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')

    routingType string

    The routing types that are supported for action requests.

    endpoint str

    The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}')

    name str

    The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')

    routing_type str

    The routing types that are supported for action requests.

    endpoint String

    The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}')

    name String

    The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')

    routingType String

    The routing types that are supported for action requests.

    CustomRPResourceTypeRouteDefinitionResponse

    Endpoint string

    The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}')

    Name string

    The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')

    RoutingType string

    The routing types that are supported for resource requests.

    Endpoint string

    The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}')

    Name string

    The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')

    RoutingType string

    The routing types that are supported for resource requests.

    endpoint String

    The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}')

    name String

    The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')

    routingType String

    The routing types that are supported for resource requests.

    endpoint string

    The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}')

    name string

    The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')

    routingType string

    The routing types that are supported for resource requests.

    endpoint str

    The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}')

    name str

    The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')

    routing_type str

    The routing types that are supported for resource requests.

    endpoint String

    The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}')

    name String

    The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')

    routingType String

    The routing types that are supported for resource requests.

    CustomRPValidationsResponse

    Specification string

    A link to the validation specification. The specification must be hosted on raw.githubusercontent.com.

    ValidationType string

    The type of validation to run against a matching request.

    Specification string

    A link to the validation specification. The specification must be hosted on raw.githubusercontent.com.

    ValidationType string

    The type of validation to run against a matching request.

    specification String

    A link to the validation specification. The specification must be hosted on raw.githubusercontent.com.

    validationType String

    The type of validation to run against a matching request.

    specification string

    A link to the validation specification. The specification must be hosted on raw.githubusercontent.com.

    validationType string

    The type of validation to run against a matching request.

    specification str

    A link to the validation specification. The specification must be hosted on raw.githubusercontent.com.

    validation_type str

    The type of validation to run against a matching request.

    specification String

    A link to the validation specification. The specification must be hosted on raw.githubusercontent.com.

    validationType String

    The type of validation to run against a matching request.

    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.20.1 published on Friday, Dec 1, 2023 by Pulumi