Note: This module is Preview.
This module involves the Parent-Child Model concept in OSBA, please refer to the Parent-Child Model doc.
| Plan Name | Description |
|---|---|
account |
This plan provisions a general purpose v2 account. General-purpose v2 storage accounts support the latest Azure Storage features and incorporate all of the functionality of general-purpose v1 and Blob storage accounts. General-purpose v2 accounts deliver the lowest per-gigabyte capacity prices for Azure Storage, as well as industry-competitive transaction prices. |
Provisions a general purpose v2 storage account.
| Parameter Name | Type | Description | Required | Default Value |
|---|---|---|---|---|
location |
string |
The Azure region in which to provision applicable resources. | Y | |
resourceGroup |
string |
The (new or existing) resource group with which to associate new resources. | Y | |
enableNonHttpsTraffic |
string |
Specify whether non-https traffic is enabled. Allowed values:["enabled", "disabled"]. | N | If not provided, "disabled" will be used as the default value. That is, only https traffic is allowed. |
accessTier |
string |
The access tier used for billing. Allowed values: ["Hot", "Cool"]. Hot storage is optimized for storing data that is accessed frequently ,and cool storage is optimized for storing data that is infrequently accessed and stored for at least 30 days. Note : accountType "Premium_LRS" only supports "Hot" in this field |
N | If not provided, "Hot" will be used as the default value. |
accountType |
string |
A combination of account kind and replication strategy. All possible values: ["Standard_LRS", "Standard_GRS", "Standard_RAGRS", "Standard_ZRS", "Premium_LRS"]. Note: ZRS is only available in several regions, check here for allowed regions to use ZRS. | N | If not provided, "Standard_LRS" will be used as the default value for all plans. |
tags |
map[string]string |
Tags to be applied to new resources, specified as key/value pairs. | N | Tags (even if none are specified) are automatically supplemented with heritage: open-service-broker-azure. |
Returns a copy of one shared set of credentials.
This binding operation does not support any parameters.
Binding returns the following connection details and shared credentials:
| Field Name | Type | Description |
|---|---|---|
storageAccountName |
string |
The storage account name. |
accessKey |
string |
A key (password) for accessing the storage account. |
primaryBlobServiceEndPoint |
string |
Primary blob service end point. |
primaryTableServiceEndPoint |
string |
Primary table service end point. |
primaryFileServiceEndPoint |
string |
Primary file service end point. |
primaryQueueServiceEndPoint |
string |
Primary queue service end point. |
Does nothing.
Updates an existing storage account.
| Parameter Name | Type | Description | Required |
|---|---|---|---|
enableNonHttpsTraffic |
string |
Specify whether non-https traffic is enabled. Allowed values:["enabled", "disabled"]. | N |
accessTier |
string |
The access tier used for billing. Allowed values: ["Hot", "Cool"]. Hot storage is optimized for storing data that is accessed frequently ,and cool storage is optimized for storing data that is infrequently accessed and stored for at least 30 days. Note : accountType "Premium_LRS" only supports "Hot" in this field. |
N |
accountType |
string |
A combination of account kind and replication strategy. You can only update ["Standard_LRS", "Standard_GRS", "Standard_RAGRS"] accounts to one of ["Standard_LRS", "Standard_GRS", "Standard_RAGRS"]. For "Standard_ZRS" and "Premium_LRS" accounts, they are not updatable. | N |
tags |
map[string]string |
Tags to be applied to new resources, specified as key/value pairs. | N |
Deletes the storage account.
| Plan Name | Description |
|---|---|
account |
This plan provisions a general purpose v1 account. General-purpose v1 accounts provide access to all Azure Storage services, but may not have the latest features or the lowest per gigabyte pricing. |
Provisions a general purpose v1 storage account.
| Parameter Name | Type | Description | Required | Default Value |
|---|---|---|---|---|
location |
string |
The Azure region in which to provision applicable resources. | Y | |
resourceGroup |
string |
The (new or existing) resource group with which to associate new resources. | Y | |
enableNonHttpsTraffic |
string |
Specify whether non-https traffic is enabled. Allowed values:["enabled", "disabled"]. | N | If not provided, "disabled" will be used as the default value. That is, only https traffic is allowed. |
accountType |
string |
A combination of account kind and replication strategy. All possible values: ["Standard_LRS", "Standard_GRS", "Standard_RAGRS", "Premium_LRS"]. | N | If not provided, "Standard_LRS" will be used as the default value for all plans. |
tags |
map[string]string |
Tags to be applied to new resources, specified as key/value pairs. | N | Tags (even if none are specified) are automatically supplemented with heritage: open-service-broker-azure. |
Returns a copy of one shared set of credentials.
This binding operation does not support any parameters.
Binding returns the following connection details and shared credentials:
| Field Name | Type | Description |
|---|---|---|
storageAccountName |
string |
The storage account name. |
accessKey |
string |
A key (password) for accessing the storage account. |
primaryBlobServiceEndPoint |
string |
Primary blob service end point. |
primaryTableServiceEndPoint |
string |
Primary table service end point. |
primaryFileServiceEndPoint |
string |
Primary file service end point. |
primaryQueueServiceEndPoint |
string |
Primary queue service end point. |
Does nothing.
Updates an existing storage account.
| Parameter Name | Type | Description | Required |
|---|---|---|---|
enableNonHttpsTraffic |
string |
Specify whether non-https traffic is enabled. Allowed values:["enabled", "disabled"]. | N |
accountType |
string |
A combination of account kind and replication strategy. You can only update ["Standard_LRS", "Standard_GRS", "Standard_RAGRS"] accounts to one of ["Standard_LRS", "Standard_GRS", "Standard_RAGRS"]. For "Premium_LRS" accounts, they are not updatable. | N |
tags |
map[string]string |
Tags to be applied to new resources, specified as key/value pairs. | N |
Deletes the storage account.
| Plan Name | Description |
|---|---|
all-in-one |
This plan provisions a a specialized Azure storage account for storing block blobs and append blobs, and automatically provisions a blob container within the account. |
Provisions a blob storage account and create a container within the account.
| Parameter Name | Type | Description | Required | Default Value |
|---|---|---|---|---|
location |
string |
The Azure region in which to provision applicable resources. | Y | |
resourceGroup |
string |
The (new or existing) resource group with which to associate new resources. | Y | |
enableNonHttpsTraffic |
string |
Specify whether non-https traffic is enabled. Allowed values:["enabled", "disabled"]. | N | If not provided, "disabled" will be used as the default value. That is, only https traffic is allowed. |
accessTier |
string |
The access tier used for billing. Allowed values: ["Hot", "Cool"]. Hot storage is optimized for storing data that is accessed frequently ,and cool storage is optimized for storing data that is infrequently accessed and stored for at least 30 days. | N | If not provided, "Hot" will be used as the default value. |
accountType |
string |
A combination of account kind and replication strategy. All possible values: ["Standard_LRS", "Standard_GRS", "Standard_RAGRS"]. | N | If not provided, "Standard_LRS" will be used as the default value for all plans. |
containerName |
string |
The name of the container which will be created inside the storage account. This name may only contain lowercase letters, numbers, and hyphens, and must begin with a letter or a number. Each hyphen must be preceded and followed by a non-hyphen character. The length of the name must between 3 and 63. | N | If not provided, a random name will be generated as the container name. |
tags |
map[string]string |
Tags to be applied to new resources, specified as key/value pairs. | N | Tags (even if none are specified) are automatically supplemented with heritage: open-service-broker-azure. |
Returns a copy of one shared set of credentials.
This binding operation does not support any parameters.
Binding returns the following connection details and shared credentials:
| Field Name | Type | Description |
|---|---|---|
storageAccountName |
string |
The storage account name. |
accessKey |
string |
A key (password) for accessing the storage account. |
primaryBlobServiceEndPoint |
string |
Primary blob service end point. |
containerName |
string |
The name of the container within the storage account. |
Does nothing.
Updates an existing storage account.
| Parameter Name | Type | Description | Required |
|---|---|---|---|
enableNonHttpsTraffic |
string |
Specify whether non-https traffic is enabled. Allowed values:["enabled", "disabled"]. | N |
accessTier |
string |
The access tier used for billing. Allowed values: ["Hot", "Cool"]. Hot storage is optimized for storing data that is accessed frequently ,and cool storage is optimized for storing data that is infrequently accessed and stored for at least 30 days. | N |
accountType |
string |
A combination of account kind and replication strategy. | N |
tags |
map[string]string |
Tags to be applied to new resources, specified as key/value pairs. | N |
Deletes the storage account and the blob container inside it.
| Plan Name | Description |
|---|---|
account |
This plan provisions a a specialized Azure storage account for storing block blobs and append blobs. |
Provisions a blob storage account.
| Parameter Name | Type | Description | Required | Default Value |
|---|---|---|---|---|
location |
string |
The Azure region in which to provision applicable resources. | Y | |
resourceGroup |
string |
The (new or existing) resource group with which to associate new resources. | Y | |
alias |
string |
Specifies an alias that can be used by later provision actions to create containers in this storage account. | Y | |
enableNonHttpsTraffic |
string |
Specify whether non-https traffic is enabled. Allowed values:["enabled", "disabled"]. | N | If not provided, "disabled" will be used as the default value. That is, only https traffic is allowed. |
accessTier |
string |
The access tier used for billing. Allowed values: ["Hot", "Cool"]. Hot storage is optimized for storing data that is accessed frequently ,and cool storage is optimized for storing data that is infrequently accessed and stored for at least 30 days. | N | If not provided, "Hot" will be used as the default value. |
accountType |
string |
A combination of account kind and replication strategy. All possible values: ["Standard_LRS", "Standard_GRS", "Standard_RAGRS"]. | N | If not provided, "Standard_LRS" will be used as the default value for all plans. |
tags |
map[string]string |
Tags to be applied to new resources, specified as key/value pairs. | N | Tags (even if none are specified) are automatically supplemented with heritage: open-service-broker-azure. |
Returns a copy of one shared set of credentials.
This binding operation does not support any parameters.
Binding returns the following connection details and shared credentials:
| Field Name | Type | Description |
|---|---|---|
storageAccountName |
string |
The storage account name. |
accessKey |
string |
A key (password) for accessing the storage account. |
primaryBlobServiceEndPoint |
string |
Primary blob service end point. |
Does nothing.
Updates an existing storage account.
| Parameter Name | Type | Description | Required |
|---|---|---|---|
enableNonHttpsTraffic |
string |
Specify whether non-https traffic is enabled. Allowed values:["enabled", "disabled"]. | N |
accessTier |
string |
The access tier used for billing. Allowed values: ["Hot", "Cool"]. Hot storage is optimized for storing data that is accessed frequently ,and cool storage is optimized for storing data that is infrequently accessed and stored for at least 30 days. | N |
accountType |
string |
A combination of account kind and replication strategy. | N |
tags |
map[string]string |
Tags to be applied to new resources, specified as key/value pairs. | N |
Deletes the storage account and the blob container inside it.
| Plan Name | Description |
|---|---|
container |
This plan creates a container inside an existing blob storage account. |
Create a blob container inside an blob storage account.
| Parameter Name | Type | Description | Required | Default Value |
|---|---|---|---|---|
parentAlias |
string |
Specifies the alias of the blob storage account upon which the should be provisioned. | Y | |
containerName |
string |
The name of the container which will be created inside the storage account. This name may only contain lowercase letters, numbers, and hyphens, and must begin with a letter or a number. Each hyphen must be preceded and followed by a non-hyphen character. The length of the name must between 3 and 63. | N | If not provided, a random name will be generated as the container name. |
Returns a copy of one shared set of credentials.
This binding operation does not support any parameters.
Binding returns the following connection details and shared credentials:
| Field Name | Type | Description |
|---|---|---|
storageAccountName |
string |
The storage account name. |
accessKey |
string |
A key (password) for accessing the storage account. |
primaryBlobServiceEndPoint |
string |
Primary blob service end point. |
containerName |
string |
The name of the container within the storage account. |
Does nothing.
Deletes the blob container.