Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. webpubsub
  5. getWebPubSubReplica
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.47.1 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.webpubsub.getWebPubSubReplica

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.47.1 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure-native

    Get the replica and its properties. Azure REST API version: 2023-03-01-preview.

    Other available API versions: 2023-06-01-preview, 2023-08-01-preview, 2024-01-01-preview, 2024-03-01, 2024-04-01-preview.

    Using getWebPubSubReplica

    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 getWebPubSubReplica(args: GetWebPubSubReplicaArgs, opts?: InvokeOptions): Promise<GetWebPubSubReplicaResult>
function getWebPubSubReplicaOutput(args: GetWebPubSubReplicaOutputArgs, opts?: InvokeOptions): Output<GetWebPubSubReplicaResult>
    def get_web_pub_sub_replica(replica_name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            resource_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetWebPubSubReplicaResult
def get_web_pub_sub_replica_output(replica_name: Optional[pulumi.Input[str]] = None,
                            resource_group_name: Optional[pulumi.Input[str]] = None,
                            resource_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetWebPubSubReplicaResult]
    func LookupWebPubSubReplica(ctx *Context, args *LookupWebPubSubReplicaArgs, opts ...InvokeOption) (*LookupWebPubSubReplicaResult, error)
func LookupWebPubSubReplicaOutput(ctx *Context, args *LookupWebPubSubReplicaOutputArgs, opts ...InvokeOption) LookupWebPubSubReplicaResultOutput

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

    public static class GetWebPubSubReplica 
{
    public static Task<GetWebPubSubReplicaResult> InvokeAsync(GetWebPubSubReplicaArgs args, InvokeOptions? opts = null)
    public static Output<GetWebPubSubReplicaResult> Invoke(GetWebPubSubReplicaInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWebPubSubReplicaResult> getWebPubSubReplica(GetWebPubSubReplicaArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:webpubsub:getWebPubSubReplica
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ReplicaName string
    The name of the replica.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ResourceName string
    The name of the resource.
    ReplicaName string
    The name of the replica.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ResourceName string
    The name of the resource.
    replicaName String
    The name of the replica.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    resourceName String
    The name of the resource.
    replicaName string
    The name of the replica.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    resourceName string
    The name of the resource.
    replica_name str
    The name of the replica.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    resource_name str
    The name of the resource.
    replicaName String
    The name of the replica.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    resourceName String
    The name of the resource.

    getWebPubSubReplica Result

    The following output properties are available:

    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state of the resource.
    SystemData Pulumi.AzureNative.WebPubSub.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Sku Pulumi.AzureNative.WebPubSub.Outputs.ResourceSkuResponse
    The billing information of the resource.
    Tags Dictionary<string, string>
    Resource tags.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state of the resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Sku ResourceSkuResponse
    The billing information of the resource.
    Tags map[string]string
    Resource tags.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    Provisioning state of the resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    sku ResourceSkuResponse
    The billing information of the resource.
    tags Map<String,String>
    Resource tags.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    provisioningState string
    Provisioning state of the resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    sku ResourceSkuResponse
    The billing information of the resource.
    tags {[key: string]: string}
    Resource tags.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    provisioning_state str
    Provisioning state of the resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    sku ResourceSkuResponse
    The billing information of the resource.
    tags Mapping[str, str]
    Resource tags.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    Provisioning state of the resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    sku Property Map
    The billing information of the resource.
    tags Map<String>
    Resource tags.

    Supporting Types

    ResourceSkuResponse

    Family string
    Not used. Retained for future use.
    Name string

    The name of the SKU. Required.

    Allowed values: Standard_S1, Free_F1, Premium_P1

    Size string
    Not used. Retained for future use.
    Capacity int

    Optional, integer. The unit count of the resource. 1 by default.

    If present, following values are allowed: Free: 1; Standard: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;

    Tier string

    Optional tier of this particular SKU. 'Standard' or 'Free'.

    Basic is deprecated, use Standard instead.

    Family string
    Not used. Retained for future use.
    Name string

    The name of the SKU. Required.

    Allowed values: Standard_S1, Free_F1, Premium_P1

    Size string
    Not used. Retained for future use.
    Capacity int

    Optional, integer. The unit count of the resource. 1 by default.

    If present, following values are allowed: Free: 1; Standard: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;

    Tier string

    Optional tier of this particular SKU. 'Standard' or 'Free'.

    Basic is deprecated, use Standard instead.

    family String
    Not used. Retained for future use.
    name String

    The name of the SKU. Required.

    Allowed values: Standard_S1, Free_F1, Premium_P1

    size String
    Not used. Retained for future use.
    capacity Integer

    Optional, integer. The unit count of the resource. 1 by default.

    If present, following values are allowed: Free: 1; Standard: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;

    tier String

    Optional tier of this particular SKU. 'Standard' or 'Free'.

    Basic is deprecated, use Standard instead.

    family string
    Not used. Retained for future use.
    name string

    The name of the SKU. Required.

    Allowed values: Standard_S1, Free_F1, Premium_P1

    size string
    Not used. Retained for future use.
    capacity number

    Optional, integer. The unit count of the resource. 1 by default.

    If present, following values are allowed: Free: 1; Standard: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;

    tier string

    Optional tier of this particular SKU. 'Standard' or 'Free'.

    Basic is deprecated, use Standard instead.

    family str
    Not used. Retained for future use.
    name str

    The name of the SKU. Required.

    Allowed values: Standard_S1, Free_F1, Premium_P1

    size str
    Not used. Retained for future use.
    capacity int

    Optional, integer. The unit count of the resource. 1 by default.

    If present, following values are allowed: Free: 1; Standard: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;

    tier str

    Optional tier of this particular SKU. 'Standard' or 'Free'.

    Basic is deprecated, use Standard instead.

    family String
    Not used. Retained for future use.
    name String

    The name of the SKU. Required.

    Allowed values: Standard_S1, Free_F1, Premium_P1

    size String
    Not used. Retained for future use.
    capacity Number

    Optional, integer. The unit count of the resource. 1 by default.

    If present, following values are allowed: Free: 1; Standard: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;

    tier String

    Optional tier of this particular SKU. 'Standard' or 'Free'.

    Basic is deprecated, use Standard instead.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    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.47.1 published on Monday, Jun 24, 2024 by Pulumi
    pulumi/pulumi-azure-native