aboutsummaryrefslogtreecommitdiff
path: root/man/coredns-azure.7
diff options
context:
space:
mode:
Diffstat (limited to 'man/coredns-azure.7')
-rw-r--r--man/coredns-azure.770
1 files changed, 70 insertions, 0 deletions
diff --git a/man/coredns-azure.7 b/man/coredns-azure.7
new file mode 100644
index 000000000..2a4bdcd01
--- /dev/null
+++ b/man/coredns-azure.7
@@ -0,0 +1,70 @@
+.\" Generated by Mmark Markdown Processer - mmark.nl
+.TH "COREDNS-AZURE" 7 "August 2019" "CoreDNS" "CoreDNS Plugins"
+
+.SH "NAME"
+.PP
+\fIazure\fP - enables serving zone data from Microsoft Azure DNS service.
+
+.SH "DESCRIPTION"
+.PP
+The azure plugin is useful for serving zones from Microsoft Azure DNS. The \fIazure\fP plugin supports
+all the DNS records supported by Azure, viz. A, AAAA, CNAME, MX, NS, PTR, SOA, SRV, and TXT
+record types.
+
+.SH "SYNTAX"
+.PP
+.RS
+
+.nf
+azure RESOURCE\_GROUP:ZONE... {
+ tenant TENANT\_ID
+ client CLIENT\_ID
+ secret CLIENT\_SECRET
+ subscription SUBSCRIPTION\_ID
+ environment ENVIRONMENT
+ fallthrough [ZONES...]
+}
+
+.fi
+.RE
+
+.IP \(bu 4
+\fBRESOURCE_GROUP:ZONE\fP is the resource group to which the hosted zones belongs on Azure,
+and \fBZONE\fP the zone that contains data.
+.IP \(bu 4
+\fBCLIENT_ID\fP and \fBCLIENT_SECRET\fP are the credentials for Azure, and \fB\fCtenant\fR specifies the
+\fBTENANT_ID\fP to be used. \fBSUBSCRIPTION_ID\fP is the subscription ID. All of these are needed
+to access the data in Azure.
+.IP \(bu 4
+\fB\fCenvironment\fR specifies the Azure \fBENVIRONMENT\fP.
+.IP \(bu 4
+\fB\fCfallthrough\fR If zone matches and no record can be generated, pass request to the next plugin.
+If \fBZONES\fP is omitted, then fallthrough happens for all zones for which the plugin is
+authoritative.
+
+
+.SH "EXAMPLES"
+.PP
+Enable the \fIazure\fP plugin with Azure credentials for the zone \fB\fCexample.org\fR:
+
+.PP
+.RS
+
+.nf
+example.org {
+ azure resource\_group\_foo:example.org {
+ tenant 123abc\-123abc\-123abc\-123abc
+ client 123abc\-123abc\-123abc\-234xyz
+ subscription 123abc\-123abc\-123abc\-563abc
+ secret mysecret
+ }
+}
+
+.fi
+.RE
+
+.SH "ALSO SEE"
+.PP
+The Azure DNS Overview
+\[la]https://docs.microsoft.com/en-us/azure/dns/dns-overview\[ra].
+