1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. getWorkspaceApiVersionSet
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.apimanagement.getWorkspaceApiVersionSet

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Gets the details of the Api Version Set specified by its identifier.

Uses Azure REST API version 2022-09-01-preview.

Other available API versions: 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. 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 getWorkspaceApiVersionSet

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 getWorkspaceApiVersionSet(args: GetWorkspaceApiVersionSetArgs, opts?: InvokeOptions): Promise<GetWorkspaceApiVersionSetResult>
function getWorkspaceApiVersionSetOutput(args: GetWorkspaceApiVersionSetOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceApiVersionSetResult>
Copy
def get_workspace_api_version_set(resource_group_name: Optional[str] = None,
                                  service_name: Optional[str] = None,
                                  version_set_id: Optional[str] = None,
                                  workspace_id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetWorkspaceApiVersionSetResult
def get_workspace_api_version_set_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                  service_name: Optional[pulumi.Input[str]] = None,
                                  version_set_id: Optional[pulumi.Input[str]] = None,
                                  workspace_id: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceApiVersionSetResult]
Copy
func LookupWorkspaceApiVersionSet(ctx *Context, args *LookupWorkspaceApiVersionSetArgs, opts ...InvokeOption) (*LookupWorkspaceApiVersionSetResult, error)
func LookupWorkspaceApiVersionSetOutput(ctx *Context, args *LookupWorkspaceApiVersionSetOutputArgs, opts ...InvokeOption) LookupWorkspaceApiVersionSetResultOutput
Copy

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

public static class GetWorkspaceApiVersionSet 
{
    public static Task<GetWorkspaceApiVersionSetResult> InvokeAsync(GetWorkspaceApiVersionSetArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspaceApiVersionSetResult> Invoke(GetWorkspaceApiVersionSetInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWorkspaceApiVersionSetResult> getWorkspaceApiVersionSet(GetWorkspaceApiVersionSetArgs args, InvokeOptions options)
public static Output<GetWorkspaceApiVersionSetResult> getWorkspaceApiVersionSet(GetWorkspaceApiVersionSetArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apimanagement:getWorkspaceApiVersionSet
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

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.
VersionSetId
This property is required.
Changes to this property will trigger replacement.
string
Api Version Set identifier. Must be unique in the current API Management service instance.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
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.
VersionSetId
This property is required.
Changes to this property will trigger replacement.
string
Api Version Set identifier. Must be unique in the current API Management service instance.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
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.
versionSetId
This property is required.
Changes to this property will trigger replacement.
String
Api Version Set identifier. Must be unique in the current API Management service instance.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.
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.
versionSetId
This property is required.
Changes to this property will trigger replacement.
string
Api Version Set identifier. Must be unique in the current API Management service instance.
workspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
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.
version_set_id
This property is required.
Changes to this property will trigger replacement.
str
Api Version Set identifier. Must be unique in the current API Management service instance.
workspace_id
This property is required.
Changes to this property will trigger replacement.
str
Workspace identifier. Must be unique in the current API Management service instance.
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.
versionSetId
This property is required.
Changes to this property will trigger replacement.
String
Api Version Set identifier. Must be unique in the current API Management service instance.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.

getWorkspaceApiVersionSet Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
DisplayName string
Name of API Version Set
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
VersioningScheme string
An value that determines where the API Version identifier will be located in a HTTP request.
Description string
Description of API Version Set.
VersionHeaderName string
Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
VersionQueryName string
Name of query parameter that indicates the API Version if versioningScheme is set to query.
AzureApiVersion string
The Azure API version of the resource.
DisplayName string
Name of API Version Set
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
VersioningScheme string
An value that determines where the API Version identifier will be located in a HTTP request.
Description string
Description of API Version Set.
VersionHeaderName string
Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
VersionQueryName string
Name of query parameter that indicates the API Version if versioningScheme is set to query.
azureApiVersion String
The Azure API version of the resource.
displayName String
Name of API Version Set
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
versioningScheme String
An value that determines where the API Version identifier will be located in a HTTP request.
description String
Description of API Version Set.
versionHeaderName String
Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
versionQueryName String
Name of query parameter that indicates the API Version if versioningScheme is set to query.
azureApiVersion string
The Azure API version of the resource.
displayName string
Name of API Version Set
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
versioningScheme string
An value that determines where the API Version identifier will be located in a HTTP request.
description string
Description of API Version Set.
versionHeaderName string
Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
versionQueryName string
Name of query parameter that indicates the API Version if versioningScheme is set to query.
azure_api_version str
The Azure API version of the resource.
display_name str
Name of API Version Set
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
versioning_scheme str
An value that determines where the API Version identifier will be located in a HTTP request.
description str
Description of API Version Set.
version_header_name str
Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
version_query_name str
Name of query parameter that indicates the API Version if versioningScheme is set to query.
azureApiVersion String
The Azure API version of the resource.
displayName String
Name of API Version Set
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
versioningScheme String
An value that determines where the API Version identifier will be located in a HTTP request.
description String
Description of API Version Set.
versionHeaderName String
Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
versionQueryName String
Name of query parameter that indicates the API Version if versioningScheme is set to query.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi