1. Packages
  2. Azure Native
  3. API Docs
  4. cognitiveservices
  5. getDeployment
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.36.0 published on Monday, Apr 8, 2024 by Pulumi

azure-native.cognitiveservices.getDeployment

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.36.0 published on Monday, Apr 8, 2024 by Pulumi

    Gets the specified deployments associated with the Cognitive Services account. Azure REST API version: 2023-05-01.

    Other available API versions: 2023-10-01-preview.

    Using getDeployment

    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 getDeployment(args: GetDeploymentArgs, opts?: InvokeOptions): Promise<GetDeploymentResult>
    function getDeploymentOutput(args: GetDeploymentOutputArgs, opts?: InvokeOptions): Output<GetDeploymentResult>
    def get_deployment(account_name: Optional[str] = None,
                       deployment_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetDeploymentResult
    def get_deployment_output(account_name: Optional[pulumi.Input[str]] = None,
                       deployment_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentResult]
    func LookupDeployment(ctx *Context, args *LookupDeploymentArgs, opts ...InvokeOption) (*LookupDeploymentResult, error)
    func LookupDeploymentOutput(ctx *Context, args *LookupDeploymentOutputArgs, opts ...InvokeOption) LookupDeploymentResultOutput

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

    public static class GetDeployment 
    {
        public static Task<GetDeploymentResult> InvokeAsync(GetDeploymentArgs args, InvokeOptions? opts = null)
        public static Output<GetDeploymentResult> Invoke(GetDeploymentInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:cognitiveservices:getDeployment
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountName string
    The name of Cognitive Services account.
    DeploymentName string
    The name of the deployment associated with the Cognitive Services Account
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AccountName string
    The name of Cognitive Services account.
    DeploymentName string
    The name of the deployment associated with the Cognitive Services Account
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    accountName String
    The name of Cognitive Services account.
    deploymentName String
    The name of the deployment associated with the Cognitive Services Account
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    accountName string
    The name of Cognitive Services account.
    deploymentName string
    The name of the deployment associated with the Cognitive Services Account
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    account_name str
    The name of Cognitive Services account.
    deployment_name str
    The name of the deployment associated with the Cognitive Services Account
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    accountName String
    The name of Cognitive Services account.
    deploymentName String
    The name of the deployment associated with the Cognitive Services Account
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getDeployment Result

    The following output properties are available:

    Etag string
    Resource Etag.
    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
    Properties Pulumi.AzureNative.CognitiveServices.Outputs.DeploymentPropertiesResponse
    Properties of Cognitive Services account deployment.
    SystemData Pulumi.AzureNative.CognitiveServices.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Sku Pulumi.AzureNative.CognitiveServices.Outputs.SkuResponse
    The resource model definition representing SKU
    Etag string
    Resource Etag.
    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
    Properties DeploymentPropertiesResponse
    Properties of Cognitive Services account deployment.
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Sku SkuResponse
    The resource model definition representing SKU
    etag String
    Resource Etag.
    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
    properties DeploymentPropertiesResponse
    Properties of Cognitive Services account deployment.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    sku SkuResponse
    The resource model definition representing SKU
    etag string
    Resource Etag.
    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
    properties DeploymentPropertiesResponse
    Properties of Cognitive Services account deployment.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    sku SkuResponse
    The resource model definition representing SKU
    etag str
    Resource Etag.
    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
    properties DeploymentPropertiesResponse
    Properties of Cognitive Services account deployment.
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    sku SkuResponse
    The resource model definition representing SKU
    etag String
    Resource Etag.
    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
    properties Property Map
    Properties of Cognitive Services account deployment.
    systemData Property Map
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    sku Property Map
    The resource model definition representing SKU

    Supporting Types

    CallRateLimitResponse

    Count double
    The count value of Call Rate Limit.
    RenewalPeriod double
    The renewal period in seconds of Call Rate Limit.
    Rules List<Pulumi.AzureNative.CognitiveServices.Inputs.ThrottlingRuleResponse>
    Count float64
    The count value of Call Rate Limit.
    RenewalPeriod float64
    The renewal period in seconds of Call Rate Limit.
    Rules []ThrottlingRuleResponse
    count Double
    The count value of Call Rate Limit.
    renewalPeriod Double
    The renewal period in seconds of Call Rate Limit.
    rules List<ThrottlingRuleResponse>
    count number
    The count value of Call Rate Limit.
    renewalPeriod number
    The renewal period in seconds of Call Rate Limit.
    rules ThrottlingRuleResponse[]
    count float
    The count value of Call Rate Limit.
    renewal_period float
    The renewal period in seconds of Call Rate Limit.
    rules Sequence[ThrottlingRuleResponse]
    count Number
    The count value of Call Rate Limit.
    renewalPeriod Number
    The renewal period in seconds of Call Rate Limit.
    rules List<Property Map>

    DeploymentModelResponse

    CallRateLimit Pulumi.AzureNative.CognitiveServices.Inputs.CallRateLimitResponse
    The call rate limit Cognitive Services account.
    Format string
    Deployment model format.
    Name string
    Deployment model name.
    Source string
    Optional. Deployment model source ARM resource ID.
    Version string
    Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API.
    CallRateLimit CallRateLimitResponse
    The call rate limit Cognitive Services account.
    Format string
    Deployment model format.
    Name string
    Deployment model name.
    Source string
    Optional. Deployment model source ARM resource ID.
    Version string
    Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API.
    callRateLimit CallRateLimitResponse
    The call rate limit Cognitive Services account.
    format String
    Deployment model format.
    name String
    Deployment model name.
    source String
    Optional. Deployment model source ARM resource ID.
    version String
    Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API.
    callRateLimit CallRateLimitResponse
    The call rate limit Cognitive Services account.
    format string
    Deployment model format.
    name string
    Deployment model name.
    source string
    Optional. Deployment model source ARM resource ID.
    version string
    Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API.
    call_rate_limit CallRateLimitResponse
    The call rate limit Cognitive Services account.
    format str
    Deployment model format.
    name str
    Deployment model name.
    source str
    Optional. Deployment model source ARM resource ID.
    version str
    Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API.
    callRateLimit Property Map
    The call rate limit Cognitive Services account.
    format String
    Deployment model format.
    name String
    Deployment model name.
    source String
    Optional. Deployment model source ARM resource ID.
    version String
    Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API.

    DeploymentPropertiesResponse

    CallRateLimit Pulumi.AzureNative.CognitiveServices.Inputs.CallRateLimitResponse
    The call rate limit Cognitive Services account.
    Capabilities Dictionary<string, string>
    The capabilities.
    ProvisioningState string
    Gets the status of the resource at the time the operation was called.
    RateLimits List<Pulumi.AzureNative.CognitiveServices.Inputs.ThrottlingRuleResponse>
    Model Pulumi.AzureNative.CognitiveServices.Inputs.DeploymentModelResponse
    Properties of Cognitive Services account deployment model.
    RaiPolicyName string
    The name of RAI policy.
    ScaleSettings Pulumi.AzureNative.CognitiveServices.Inputs.DeploymentScaleSettingsResponse
    Properties of Cognitive Services account deployment model.
    VersionUpgradeOption string
    Deployment model version upgrade option.
    CallRateLimit CallRateLimitResponse
    The call rate limit Cognitive Services account.
    Capabilities map[string]string
    The capabilities.
    ProvisioningState string
    Gets the status of the resource at the time the operation was called.
    RateLimits []ThrottlingRuleResponse
    Model DeploymentModelResponse
    Properties of Cognitive Services account deployment model.
    RaiPolicyName string
    The name of RAI policy.
    ScaleSettings DeploymentScaleSettingsResponse
    Properties of Cognitive Services account deployment model.
    VersionUpgradeOption string
    Deployment model version upgrade option.
    callRateLimit CallRateLimitResponse
    The call rate limit Cognitive Services account.
    capabilities Map<String,String>
    The capabilities.
    provisioningState String
    Gets the status of the resource at the time the operation was called.
    rateLimits List<ThrottlingRuleResponse>
    model DeploymentModelResponse
    Properties of Cognitive Services account deployment model.
    raiPolicyName String
    The name of RAI policy.
    scaleSettings DeploymentScaleSettingsResponse
    Properties of Cognitive Services account deployment model.
    versionUpgradeOption String
    Deployment model version upgrade option.
    callRateLimit CallRateLimitResponse
    The call rate limit Cognitive Services account.
    capabilities {[key: string]: string}
    The capabilities.
    provisioningState string
    Gets the status of the resource at the time the operation was called.
    rateLimits ThrottlingRuleResponse[]
    model DeploymentModelResponse
    Properties of Cognitive Services account deployment model.
    raiPolicyName string
    The name of RAI policy.
    scaleSettings DeploymentScaleSettingsResponse
    Properties of Cognitive Services account deployment model.
    versionUpgradeOption string
    Deployment model version upgrade option.
    call_rate_limit CallRateLimitResponse
    The call rate limit Cognitive Services account.
    capabilities Mapping[str, str]
    The capabilities.
    provisioning_state str
    Gets the status of the resource at the time the operation was called.
    rate_limits Sequence[ThrottlingRuleResponse]
    model DeploymentModelResponse
    Properties of Cognitive Services account deployment model.
    rai_policy_name str
    The name of RAI policy.
    scale_settings DeploymentScaleSettingsResponse
    Properties of Cognitive Services account deployment model.
    version_upgrade_option str
    Deployment model version upgrade option.
    callRateLimit Property Map
    The call rate limit Cognitive Services account.
    capabilities Map<String>
    The capabilities.
    provisioningState String
    Gets the status of the resource at the time the operation was called.
    rateLimits List<Property Map>
    model Property Map
    Properties of Cognitive Services account deployment model.
    raiPolicyName String
    The name of RAI policy.
    scaleSettings Property Map
    Properties of Cognitive Services account deployment model.
    versionUpgradeOption String
    Deployment model version upgrade option.

    DeploymentScaleSettingsResponse

    ActiveCapacity int
    Deployment active capacity. This value might be different from capacity if customer recently updated capacity.
    Capacity int
    Deployment capacity.
    ScaleType string
    Deployment scale type.
    ActiveCapacity int
    Deployment active capacity. This value might be different from capacity if customer recently updated capacity.
    Capacity int
    Deployment capacity.
    ScaleType string
    Deployment scale type.
    activeCapacity Integer
    Deployment active capacity. This value might be different from capacity if customer recently updated capacity.
    capacity Integer
    Deployment capacity.
    scaleType String
    Deployment scale type.
    activeCapacity number
    Deployment active capacity. This value might be different from capacity if customer recently updated capacity.
    capacity number
    Deployment capacity.
    scaleType string
    Deployment scale type.
    active_capacity int
    Deployment active capacity. This value might be different from capacity if customer recently updated capacity.
    capacity int
    Deployment capacity.
    scale_type str
    Deployment scale type.
    activeCapacity Number
    Deployment active capacity. This value might be different from capacity if customer recently updated capacity.
    capacity Number
    Deployment capacity.
    scaleType String
    Deployment scale type.

    RequestMatchPatternResponse

    Method string
    Path string
    Method string
    Path string
    method String
    path String
    method string
    path string
    method str
    path str
    method String
    path String

    SkuResponse

    Name string
    The name of the SKU. Ex - P3. It is typically a letter+number code
    Capacity int
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    Family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    Size string
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    Tier string
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
    Name string
    The name of the SKU. Ex - P3. It is typically a letter+number code
    Capacity int
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    Family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    Size string
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    Tier string
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
    name String
    The name of the SKU. Ex - P3. It is typically a letter+number code
    capacity Integer
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    family String
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size String
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    tier String
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
    name string
    The name of the SKU. Ex - P3. It is typically a letter+number code
    capacity number
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size string
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    tier string
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
    name str
    The name of the SKU. Ex - P3. It is typically a letter+number code
    capacity int
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    family str
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size str
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    tier str
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
    name String
    The name of the SKU. Ex - P3. It is typically a letter+number code
    capacity Number
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    family String
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size String
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    tier String
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

    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.

    ThrottlingRuleResponse

    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.36.0 published on Monday, Apr 8, 2024 by Pulumi