Module appplatform
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.
Resources
Functions
Others
- GetSpringCloudServiceArgs
- GetSpringCloudServiceResult
- SpringCloudAppArgs
- SpringCloudAppState
- SpringCloudServiceArgs
- SpringCloudServiceState
Resources
Resource SpringCloudApp
class SpringCloudApp extends CustomResourceManage an Azure Spring Cloud Application.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "Southeast Asia"});
const exampleSpringCloudService = new azure.appplatform.SpringCloudService("exampleSpringCloudService", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
});
const exampleSpringCloudApp = new azure.appplatform.SpringCloudApp("exampleSpringCloudApp", {
resourceGroupName: exampleResourceGroup.name,
serviceName: exampleSpringCloudService.name,
});constructor
new SpringCloudApp(name: string, args: SpringCloudAppArgs, opts?: pulumi.CustomResourceOptions)Create a SpringCloudApp resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SpringCloudAppState, opts?: pulumi.CustomResourceOptions): SpringCloudAppGet an existing SpringCloudApp resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is SpringCloudAppReturns true if the given object is an instance of SpringCloudApp. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property name
public name: pulumi.Output<string>;Specifies the name of the Spring Cloud Application. Changing this forces a new resource to be created.
property resourceGroupName
public resourceGroupName: pulumi.Output<string>;Specifies the name of the resource group in which to create the Spring Cloud Application. Changing this forces a new resource to be created.
property serviceName
public serviceName: pulumi.Output<string>;Specifies the name of the Spring Cloud Service resource. Changing this forces a new resource to be created.
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
Resource SpringCloudService
class SpringCloudService extends CustomResourceManages an Azure Spring Cloud Service.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "Southeast Asia"});
const exampleSpringCloudService = new azure.appplatform.SpringCloudService("exampleSpringCloudService", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
config_server_git_setting: {
uri: "https://github.com/Azure-Samples/piggymetrics",
label: "config",
searchPaths: [
"dir1",
"dir2",
],
},
tags: {
Env: "staging",
},
});constructor
new SpringCloudService(name: string, args: SpringCloudServiceArgs, opts?: pulumi.CustomResourceOptions)Create a SpringCloudService resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SpringCloudServiceState, opts?: pulumi.CustomResourceOptions): SpringCloudServiceGet an existing SpringCloudService resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is SpringCloudServiceReturns true if the given object is an instance of SpringCloudService. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property configServerGitSetting
public configServerGitSetting: pulumi.Output<SpringCloudServiceConfigServerGitSetting | undefined>;A configServerGitSetting block as defined below.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property location
public location: pulumi.Output<string>;Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
property name
public name: pulumi.Output<string>;Specifies the name of the Spring Cloud Service resource. Changing this forces a new resource to be created.
property resourceGroupName
public resourceGroupName: pulumi.Output<string>;Specifies The name of the resource group in which to create the Spring Cloud Service. Changing this forces a new resource to be created.
property tags
public tags: pulumi.Output<{[key: string]: string} | undefined>;A mapping of tags to assign to the resource.
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
Functions
Function getSpringCloudService
getSpringCloudService(args: GetSpringCloudServiceArgs, opts?: pulumi.InvokeOptions): Promise<GetSpringCloudServiceResult>Use this data source to access information about an existing Spring Cloud Service.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.appplatform.getSpringCloudService({
name: azurerm_spring_cloud_service.example.name,
resourceGroupName: azurerm_spring_cloud_service.example.resource_group_name,
});
export const springCloudServiceId = example.then(example => example.id);Others
interface GetSpringCloudServiceArgs
interface GetSpringCloudServiceArgsA collection of arguments for invoking getSpringCloudService.
property name
name: string;Specifies The name of the Spring Cloud Service resource.
property resourceGroupName
resourceGroupName: string;Specifies the name of the Resource Group where the Spring Cloud Service exists.
interface GetSpringCloudServiceResult
interface GetSpringCloudServiceResultA collection of values returned by getSpringCloudService.
property configServerGitSettings
configServerGitSettings: GetSpringCloudServiceConfigServerGitSetting[];A configServerGitSetting block as defined below.
property id
id: string;The provider-assigned unique ID for this managed resource.
property location
location: string;The location of Spring Cloud Service.
property name
name: string;The name to identify on the Git repository.
property resourceGroupName
resourceGroupName: string;property tags
tags: {[key: string]: string};A mapping of tags assigned to Spring Cloud Service.
interface SpringCloudAppArgs
interface SpringCloudAppArgsThe set of arguments for constructing a SpringCloudApp resource.
property name
name?: pulumi.Input<string>;Specifies the name of the Spring Cloud Application. Changing this forces a new resource to be created.
property resourceGroupName
resourceGroupName: pulumi.Input<string>;Specifies the name of the resource group in which to create the Spring Cloud Application. Changing this forces a new resource to be created.
property serviceName
serviceName: pulumi.Input<string>;Specifies the name of the Spring Cloud Service resource. Changing this forces a new resource to be created.
interface SpringCloudAppState
interface SpringCloudAppStateInput properties used for looking up and filtering SpringCloudApp resources.
property name
name?: pulumi.Input<string>;Specifies the name of the Spring Cloud Application. Changing this forces a new resource to be created.
property resourceGroupName
resourceGroupName?: pulumi.Input<string>;Specifies the name of the resource group in which to create the Spring Cloud Application. Changing this forces a new resource to be created.
property serviceName
serviceName?: pulumi.Input<string>;Specifies the name of the Spring Cloud Service resource. Changing this forces a new resource to be created.
interface SpringCloudServiceArgs
interface SpringCloudServiceArgsThe set of arguments for constructing a SpringCloudService resource.
property configServerGitSetting
configServerGitSetting?: pulumi.Input<SpringCloudServiceConfigServerGitSetting>;A configServerGitSetting block as defined below.
property location
location?: pulumi.Input<string>;Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
property name
name?: pulumi.Input<string>;Specifies the name of the Spring Cloud Service resource. Changing this forces a new resource to be created.
property resourceGroupName
resourceGroupName: pulumi.Input<string>;Specifies The name of the resource group in which to create the Spring Cloud Service. Changing this forces a new resource to be created.
property tags
tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;A mapping of tags to assign to the resource.
interface SpringCloudServiceState
interface SpringCloudServiceStateInput properties used for looking up and filtering SpringCloudService resources.
property configServerGitSetting
configServerGitSetting?: pulumi.Input<SpringCloudServiceConfigServerGitSetting>;A configServerGitSetting block as defined below.
property location
location?: pulumi.Input<string>;Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
property name
name?: pulumi.Input<string>;Specifies the name of the Spring Cloud Service resource. Changing this forces a new resource to be created.
property resourceGroupName
resourceGroupName?: pulumi.Input<string>;Specifies The name of the resource group in which to create the Spring Cloud Service. Changing this forces a new resource to be created.
property tags
tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;A mapping of tags to assign to the resource.