This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

appplatform¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.appplatform.AwaitableGetSpringCloudServiceResult(config_server_git_settings=None, id=None, location=None, name=None, resource_group_name=None, tags=None)¶

class pulumi_azure.appplatform.GetSpringCloudServiceResult(config_server_git_settings=None, id=None, location=None, name=None, resource_group_name=None, tags=None)¶

A collection of values returned by getSpringCloudService.

config_server_git_settings = None¶: A config_server_git_setting block as defined below.

id = None¶: The provider-assigned unique ID for this managed resource.

location = None¶: The location of Spring Cloud Service.

name = None¶: The name to identify on the Git repository.

tags = None¶: A mapping of tags assigned to Spring Cloud Service.

class pulumi_azure.appplatform.SpringCloudApp(resource_name, opts=None, name=None, resource_group_name=None, service_name=None, __props__=None, __name__=None, __opts__=None)¶

Manage an Azure Spring Cloud Application.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="Southeast Asia")
example_spring_cloud_service = azure.appplatform.SpringCloudService("exampleSpringCloudService",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location)
example_spring_cloud_app = azure.appplatform.SpringCloudApp("exampleSpringCloudApp",
    resource_group_name=example_resource_group.name,
    service_name=example_spring_cloud_service.name)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – Specifies the name of the Spring Cloud Application. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – Specifies the name of the resource group in which to create the Spring Cloud Application. Changing this forces a new resource to be created.
service_name (pulumi.Input[str]) – Specifies the name of the Spring Cloud Service resource. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Spring Cloud Application. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: Specifies the name of the resource group in which to create the Spring Cloud Application. Changing this forces a new resource to be created.

service_name: pulumi.Output[str] = None¶: Specifies the name of the Spring Cloud Service resource. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, name=None, resource_group_name=None, service_name=None)¶

Get an existing SpringCloudApp resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – Specifies the name of the Spring Cloud Application. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – Specifies the name of the resource group in which to create the Spring Cloud Application. Changing this forces a new resource to be created.
service_name (pulumi.Input[str]) – Specifies the name of the Spring Cloud Service resource. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.appplatform.SpringCloudService(resource_name, opts=None, config_server_git_setting=None, location=None, name=None, resource_group_name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Manages an Azure Spring Cloud Service.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="Southeast Asia")
example_spring_cloud_service = azure.appplatform.SpringCloudService("exampleSpringCloudService",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    config_server_git_setting={
        "uri": "https://github.com/Azure-Samples/piggymetrics",
        "label": "config",
        "searchPaths": [
            "dir1",
            "dir2",
        ],
    },
    tags={
        "Env": "staging",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
config_server_git_setting (pulumi.Input[dict]) – A config_server_git_setting block as defined below.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Spring Cloud Service resource. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – Specifies The name of the resource group in which to create the Spring Cloud Service. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The config_server_git_setting object supports the following:

httpBasicAuth (pulumi.Input[dict]) - A http_basic_auth block as defined below.
- password (pulumi.Input[str]) - The password used to access the Git repository server, required when the Git repository server supports Http Basic Authentication.
- username (pulumi.Input[str]) - The username that’s used to access the Git repository server, required when the Git repository server supports Http Basic Authentication.
label (pulumi.Input[str]) - The default label of the Git repository, should be the branch name, tag name, or commit-id of the repository.
repositories (pulumi.Input[list]) - One or more repository blocks as defined below.
- httpBasicAuth (pulumi.Input[dict]) - A http_basic_auth block as defined below.
  - password (pulumi.Input[str]) - The password used to access the Git repository server, required when the Git repository server supports Http Basic Authentication.
  - username (pulumi.Input[str]) - The username that’s used to access the Git repository server, required when the Git repository server supports Http Basic Authentication.
- label (pulumi.Input[str]) - The default label of the Git repository, should be the branch name, tag name, or commit-id of the repository.
- name (pulumi.Input[str]) - A name to identify on the Git repository, required only if repos exists.
- patterns (pulumi.Input[list]) - An array of strings used to match an application name. For each pattern, use the {application}/{profile} format with wildcards.
- searchPaths (pulumi.Input[list]) - An array of strings used to search subdirectories of the Git repository.
- sshAuth (pulumi.Input[dict]) - A ssh_auth block as defined below.
  - hostKey (pulumi.Input[str]) - The host key of the Git repository server, should not include the algorithm prefix as covered by host-key-algorithm.
  - hostKeyAlgorithm (pulumi.Input[str]) - The host key algorithm, should be ssh-dss, ssh-rsa, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521. Required only if host-key exists.
  - privateKey (pulumi.Input[str]) - The SSH private key to access the Git repository, required when the URI starts with git@ or ssh://.
  - strictHostKeyCheckingEnabled (pulumi.Input[bool]) - Indicates whether the Config Server instance will fail to start if the host_key does not match.
- uri (pulumi.Input[str]) - The URI of the Git repository that’s used as the Config Server back end should be started with http://, https://, git@, or ssh://.
searchPaths (pulumi.Input[list]) - An array of strings used to search subdirectories of the Git repository.
sshAuth (pulumi.Input[dict]) - A ssh_auth block as defined below.
- hostKey (pulumi.Input[str]) - The host key of the Git repository server, should not include the algorithm prefix as covered by host-key-algorithm.
- hostKeyAlgorithm (pulumi.Input[str]) - The host key algorithm, should be ssh-dss, ssh-rsa, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521. Required only if host-key exists.
- privateKey (pulumi.Input[str]) - The SSH private key to access the Git repository, required when the URI starts with git@ or ssh://.
- strictHostKeyCheckingEnabled (pulumi.Input[bool]) - Indicates whether the Config Server instance will fail to start if the host_key does not match.
uri (pulumi.Input[str]) - The URI of the default Git repository used as the Config Server back end, should be started with http://, https://, git@, or ssh://.

config_server_git_setting: pulumi.Output[dict] = None¶

A config_server_git_setting block as defined below.

httpBasicAuth (dict) - A http_basic_auth block as defined below.
- password (str) - The password used to access the Git repository server, required when the Git repository server supports Http Basic Authentication.
- username (str) - The username that’s used to access the Git repository server, required when the Git repository server supports Http Basic Authentication.
label (str) - The default label of the Git repository, should be the branch name, tag name, or commit-id of the repository.
repositories (list) - One or more repository blocks as defined below.
- httpBasicAuth (dict) - A http_basic_auth block as defined below.
  - password (str) - The password used to access the Git repository server, required when the Git repository server supports Http Basic Authentication.
  - username (str) - The username that’s used to access the Git repository server, required when the Git repository server supports Http Basic Authentication.
- label (str) - The default label of the Git repository, should be the branch name, tag name, or commit-id of the repository.
- name (str) - A name to identify on the Git repository, required only if repos exists.
- patterns (list) - An array of strings used to match an application name. For each pattern, use the {application}/{profile} format with wildcards.
- searchPaths (list) - An array of strings used to search subdirectories of the Git repository.
- sshAuth (dict) - A ssh_auth block as defined below.
  - hostKey (str) - The host key of the Git repository server, should not include the algorithm prefix as covered by host-key-algorithm.
  - hostKeyAlgorithm (str) - The host key algorithm, should be ssh-dss, ssh-rsa, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521. Required only if host-key exists.
  - privateKey (str) - The SSH private key to access the Git repository, required when the URI starts with git@ or ssh://.
  - strictHostKeyCheckingEnabled (bool) - Indicates whether the Config Server instance will fail to start if the host_key does not match.
- uri (str) - The URI of the Git repository that’s used as the Config Server back end should be started with http://, https://, git@, or ssh://.
searchPaths (list) - An array of strings used to search subdirectories of the Git repository.
sshAuth (dict) - A ssh_auth block as defined below.
- hostKey (str) - The host key of the Git repository server, should not include the algorithm prefix as covered by host-key-algorithm.
- hostKeyAlgorithm (str) - The host key algorithm, should be ssh-dss, ssh-rsa, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521. Required only if host-key exists.
- privateKey (str) - The SSH private key to access the Git repository, required when the URI starts with git@ or ssh://.
- strictHostKeyCheckingEnabled (bool) - Indicates whether the Config Server instance will fail to start if the host_key does not match.
uri (str) - The URI of the default Git repository used as the Config Server back end, should be started with http://, https://, git@, or ssh://.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Spring Cloud Service resource. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: Specifies The name of the resource group in which to create the Spring Cloud Service. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, config_server_git_setting=None, location=None, name=None, resource_group_name=None, tags=None)¶

Get an existing SpringCloudService resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
config_server_git_setting (pulumi.Input[dict]) – A config_server_git_setting block as defined below.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Spring Cloud Service resource. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – Specifies The name of the resource group in which to create the Spring Cloud Service. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The config_server_git_setting object supports the following:

httpBasicAuth (pulumi.Input[dict]) - A http_basic_auth block as defined below.
- password (pulumi.Input[str]) - The password used to access the Git repository server, required when the Git repository server supports Http Basic Authentication.
- username (pulumi.Input[str]) - The username that’s used to access the Git repository server, required when the Git repository server supports Http Basic Authentication.
label (pulumi.Input[str]) - The default label of the Git repository, should be the branch name, tag name, or commit-id of the repository.
repositories (pulumi.Input[list]) - One or more repository blocks as defined below.
- httpBasicAuth (pulumi.Input[dict]) - A http_basic_auth block as defined below.
  - password (pulumi.Input[str]) - The password used to access the Git repository server, required when the Git repository server supports Http Basic Authentication.
  - username (pulumi.Input[str]) - The username that’s used to access the Git repository server, required when the Git repository server supports Http Basic Authentication.
- label (pulumi.Input[str]) - The default label of the Git repository, should be the branch name, tag name, or commit-id of the repository.
- name (pulumi.Input[str]) - A name to identify on the Git repository, required only if repos exists.
- patterns (pulumi.Input[list]) - An array of strings used to match an application name. For each pattern, use the {application}/{profile} format with wildcards.
- searchPaths (pulumi.Input[list]) - An array of strings used to search subdirectories of the Git repository.
- sshAuth (pulumi.Input[dict]) - A ssh_auth block as defined below.
  - hostKey (pulumi.Input[str]) - The host key of the Git repository server, should not include the algorithm prefix as covered by host-key-algorithm.
  - hostKeyAlgorithm (pulumi.Input[str]) - The host key algorithm, should be ssh-dss, ssh-rsa, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521. Required only if host-key exists.
  - privateKey (pulumi.Input[str]) - The SSH private key to access the Git repository, required when the URI starts with git@ or ssh://.
  - strictHostKeyCheckingEnabled (pulumi.Input[bool]) - Indicates whether the Config Server instance will fail to start if the host_key does not match.
- uri (pulumi.Input[str]) - The URI of the Git repository that’s used as the Config Server back end should be started with http://, https://, git@, or ssh://.
searchPaths (pulumi.Input[list]) - An array of strings used to search subdirectories of the Git repository.
sshAuth (pulumi.Input[dict]) - A ssh_auth block as defined below.
- hostKey (pulumi.Input[str]) - The host key of the Git repository server, should not include the algorithm prefix as covered by host-key-algorithm.
- hostKeyAlgorithm (pulumi.Input[str]) - The host key algorithm, should be ssh-dss, ssh-rsa, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521. Required only if host-key exists.
- privateKey (pulumi.Input[str]) - The SSH private key to access the Git repository, required when the URI starts with git@ or ssh://.
- strictHostKeyCheckingEnabled (pulumi.Input[bool]) - Indicates whether the Config Server instance will fail to start if the host_key does not match.
uri (pulumi.Input[str]) - The URI of the default Git repository used as the Config Server back end, should be started with http://, https://, git@, or ssh://.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_azure.appplatform.get_spring_cloud_service(name=None, resource_group_name=None, opts=None)¶

Use this data source to access information about an existing Spring Cloud Service.

import pulumi
import pulumi_azure as azure

example = azure.appplatform.get_spring_cloud_service(name=azurerm_spring_cloud_service["example"]["name"],
    resource_group_name=azurerm_spring_cloud_service["example"]["resource_group_name"])
pulumi.export("springCloudServiceId", example.id)

Parameters

name (str) – Specifies The name of the Spring Cloud Service resource.
resource_group_name (str) – Specifies the name of the Resource Group where the Spring Cloud Service exists.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

appplatform¶

On This Page