Merge pull request #52032 from Ch3LL/fix_azure_docs

Add azure state and execution modules to doc index
This commit is contained in:
Megan Wilhite 2019-03-11 11:46:48 -04:00 committed by GitHub
commit 7d6b53cbff
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 57 additions and 15 deletions

View file

@ -38,6 +38,9 @@ execution modules
at_solaris
augeas_cfg
aws_sqs
azurearm_compute
azurearm_network
azurearm_resource
bamboohr
bcache
beacons

View file

@ -0,0 +1,6 @@
=============================
salt.modules.azurearm_compute
=============================
.. automodule:: salt.modules.azurearm_compute
:members:

View file

@ -0,0 +1,6 @@
=============================
salt.modules.azurearm_network
=============================
.. automodule:: salt.modules.azurearm_network
:members:

View file

@ -0,0 +1,6 @@
==============================
salt.modules.azurearm_resource
==============================
.. automodule:: salt.modules.azurearm_resource
:members:

View file

@ -24,6 +24,9 @@ state modules
at
augeas
aws_sqs
azurearm_compute
azurearm_network
azurearm_resource
beacon
bigip
blockdev

View file

@ -0,0 +1,6 @@
============================
salt.states.azurearm_compute
============================
.. automodule:: salt.states.azurearm_compute
:members:

View file

@ -0,0 +1,6 @@
============================
salt.states.azurearm_network
============================
.. automodule:: salt.states.azurearm_network
:members:

View file

@ -0,0 +1,6 @@
=============================
salt.states.azurearm_resource
=============================
.. automodule:: salt.states.azurearm_resource
:members:

View file

@ -20,7 +20,7 @@ Azure (ARM) Compute Execution Module
:platform: linux
:configuration: This module requires Azure Resource Manager credentials to be passed as keyword arguments
to every function in order to work properly.
to every function in order to work properly.
Required provider parameters:
@ -37,7 +37,7 @@ to every function in order to work properly.
Optional provider parameters:
**cloud_environment**: Used to point the cloud driver to different API endpoints, such as Azure GovCloud.
**cloud_environment**: Used to point the cloud driver to different API endpoints, such as Azure GovCloud.
Possible values:
* ``AZURE_PUBLIC_CLOUD`` (default)
* ``AZURE_CHINA_CLOUD``

View file

@ -20,7 +20,7 @@ Azure (ARM) Network Execution Module
:platform: linux
:configuration: This module requires Azure Resource Manager credentials to be passed as keyword arguments
to every function in order to work properly.
to every function in order to work properly.
Required provider parameters:
@ -37,7 +37,7 @@ to every function in order to work properly.
Optional provider parameters:
**cloud_environment**: Used to point the cloud driver to different API endpoints, such as Azure GovCloud.
**cloud_environment**: Used to point the cloud driver to different API endpoints, such as Azure GovCloud.
Possible values:
* ``AZURE_PUBLIC_CLOUD`` (default)
* ``AZURE_CHINA_CLOUD``

View file

@ -20,7 +20,7 @@ Azure (ARM) Resource Execution Module
:platform: linux
:configuration: This module requires Azure Resource Manager credentials to be passed as keyword arguments
to every function in order to work properly.
to every function in order to work properly.
Required provider parameters:
@ -37,7 +37,7 @@ to every function in order to work properly.
Optional provider parameters:
**cloud_environment**: Used to point the cloud driver to different API endpoints, such as Azure GovCloud.
**cloud_environment**: Used to point the cloud driver to different API endpoints, such as Azure GovCloud.
Possible values:
* ``AZURE_PUBLIC_CLOUD`` (default)
* ``AZURE_CHINA_CLOUD``

View file

@ -20,8 +20,8 @@ Azure (ARM) Compute State Module
:platform: linux
:configuration: This module requires Azure Resource Manager credentials to be passed as a dictionary of
keyword arguments to the ``connection_auth`` parameter in order to work properly. Since the authentication
parameters are sensitive, it's recommended to pass them to the states via pillar.
keyword arguments to the ``connection_auth`` parameter in order to work properly. Since the authentication
parameters are sensitive, it's recommended to pass them to the states via pillar.
Required provider parameters:
@ -62,7 +62,7 @@ parameters are sensitive, it's recommended to pass them to the states via pillar
Example states using Azure Resource Manager authentication:
.. code-block:: yaml
.. code-block:: jinja
{% set profile = salt['pillar.get']('azurearm:mysubscription') %}
Ensure availability set exists:

View file

@ -20,8 +20,8 @@ Azure (ARM) Network State Module
:platform: linux
:configuration: This module requires Azure Resource Manager credentials to be passed as a dictionary of
keyword arguments to the ``connection_auth`` parameter in order to work properly. Since the authentication
parameters are sensitive, it's recommended to pass them to the states via pillar.
keyword arguments to the ``connection_auth`` parameter in order to work properly. Since the authentication
parameters are sensitive, it's recommended to pass them to the states via pillar.
Required provider parameters:
@ -62,7 +62,7 @@ parameters are sensitive, it's recommended to pass them to the states via pillar
Example states using Azure Resource Manager authentication:
.. code-block:: yaml
.. code-block:: jinja
{% set profile = salt['pillar.get']('azurearm:mysubscription') %}
Ensure virtual network exists:

View file

@ -20,8 +20,8 @@ Azure (ARM) Resource State Module
:platform: linux
:configuration: This module requires Azure Resource Manager credentials to be passed as a dictionary of
keyword arguments to the ``connection_auth`` parameter in order to work properly. Since the authentication
parameters are sensitive, it's recommended to pass them to the states via pillar.
keyword arguments to the ``connection_auth`` parameter in order to work properly. Since the authentication
parameters are sensitive, it's recommended to pass them to the states via pillar.
Required provider parameters:
@ -62,7 +62,7 @@ parameters are sensitive, it's recommended to pass them to the states via pillar
Example states using Azure Resource Manager authentication:
.. code-block:: yaml
.. code-block:: jinja
{% set profile = salt['pillar.get']('azurearm:mysubscription') %}
Ensure resource group exists: