ServicePrincipalCertificate

Manages a Certificate associated with a Service Principal within Azure Active Directory.

NOTE: If you’re authenticating using a Service Principal then it must have permissions to both Read and write all applications and Sign in and read user profile within the Windows Azure Active Directory API.

Create a ServicePrincipalCertificate Resource

new ServicePrincipalCertificate(name: string, args: ServicePrincipalCertificateArgs, opts?: CustomResourceOptions);
@overload
def ServicePrincipalCertificate(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                encoding: Optional[str] = None,
                                end_date: Optional[str] = None,
                                end_date_relative: Optional[str] = None,
                                key_id: Optional[str] = None,
                                service_principal_id: Optional[str] = None,
                                start_date: Optional[str] = None,
                                type: Optional[str] = None,
                                value: Optional[str] = None)
@overload
def ServicePrincipalCertificate(resource_name: str,
                                args: ServicePrincipalCertificateArgs,
                                opts: Optional[ResourceOptions] = None)
func NewServicePrincipalCertificate(ctx *Context, name string, args ServicePrincipalCertificateArgs, opts ...ResourceOption) (*ServicePrincipalCertificate, error)
public ServicePrincipalCertificate(string name, ServicePrincipalCertificateArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ServicePrincipalCertificateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ServicePrincipalCertificateArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ServicePrincipalCertificateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ServicePrincipalCertificateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

ServicePrincipalCertificate Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The ServicePrincipalCertificate resource accepts the following input properties:

ServicePrincipalId string
The ID of the Service Principal for which this certificate should be created. Changing this field forces a new resource to be created.
Value string
The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the encoding argument.
Encoding string
Specifies the encoding used for the supplied certificate data. Must be one of pem, base64 or hex. Defaults to pem.
EndDate string
The End Date which the Certificate is valid until, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.
EndDateRelative string
A relative duration for which the Certificate is valid until, for example 240h (10 days) or 2400h30m. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. Changing this field forces a new resource to be created.
KeyId string
A GUID used to uniquely identify this Certificate. If not specified a GUID will be created. Changing this field forces a new resource to be created.
StartDate string
The Start Date which the Certificate is valid from, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). If this isn’t specified, the current date is used. Changing this field forces a new resource to be created.
Type string
The type of key/certificate. Must be one of AsymmetricX509Cert or Symmetric. Changing this fields forces a new resource to be created.
ServicePrincipalId string
The ID of the Service Principal for which this certificate should be created. Changing this field forces a new resource to be created.
Value string
The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the encoding argument.
Encoding string
Specifies the encoding used for the supplied certificate data. Must be one of pem, base64 or hex. Defaults to pem.
EndDate string
The End Date which the Certificate is valid until, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.
EndDateRelative string
A relative duration for which the Certificate is valid until, for example 240h (10 days) or 2400h30m. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. Changing this field forces a new resource to be created.
KeyId string
A GUID used to uniquely identify this Certificate. If not specified a GUID will be created. Changing this field forces a new resource to be created.
StartDate string
The Start Date which the Certificate is valid from, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). If this isn’t specified, the current date is used. Changing this field forces a new resource to be created.
Type string
The type of key/certificate. Must be one of AsymmetricX509Cert or Symmetric. Changing this fields forces a new resource to be created.
servicePrincipalId string
The ID of the Service Principal for which this certificate should be created. Changing this field forces a new resource to be created.
value string
The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the encoding argument.
encoding string
Specifies the encoding used for the supplied certificate data. Must be one of pem, base64 or hex. Defaults to pem.
endDate string
The End Date which the Certificate is valid until, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.
endDateRelative string
A relative duration for which the Certificate is valid until, for example 240h (10 days) or 2400h30m. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. Changing this field forces a new resource to be created.
keyId string
A GUID used to uniquely identify this Certificate. If not specified a GUID will be created. Changing this field forces a new resource to be created.
startDate string
The Start Date which the Certificate is valid from, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). If this isn’t specified, the current date is used. Changing this field forces a new resource to be created.
type string
The type of key/certificate. Must be one of AsymmetricX509Cert or Symmetric. Changing this fields forces a new resource to be created.
service_principal_id str
The ID of the Service Principal for which this certificate should be created. Changing this field forces a new resource to be created.
value str
The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the encoding argument.
encoding str
Specifies the encoding used for the supplied certificate data. Must be one of pem, base64 or hex. Defaults to pem.
end_date str
The End Date which the Certificate is valid until, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.
end_date_relative str
A relative duration for which the Certificate is valid until, for example 240h (10 days) or 2400h30m. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. Changing this field forces a new resource to be created.
key_id str
A GUID used to uniquely identify this Certificate. If not specified a GUID will be created. Changing this field forces a new resource to be created.
start_date str
The Start Date which the Certificate is valid from, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). If this isn’t specified, the current date is used. Changing this field forces a new resource to be created.
type str
The type of key/certificate. Must be one of AsymmetricX509Cert or Symmetric. Changing this fields forces a new resource to be created.

Outputs

All input properties are implicitly available as output properties. Additionally, the ServicePrincipalCertificate resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing ServicePrincipalCertificate Resource

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

public static get(name: string, id: Input<ID>, state?: ServicePrincipalCertificateState, opts?: CustomResourceOptions): ServicePrincipalCertificate
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        encoding: Optional[str] = None,
        end_date: Optional[str] = None,
        end_date_relative: Optional[str] = None,
        key_id: Optional[str] = None,
        service_principal_id: Optional[str] = None,
        start_date: Optional[str] = None,
        type: Optional[str] = None,
        value: Optional[str] = None) -> ServicePrincipalCertificate
func GetServicePrincipalCertificate(ctx *Context, name string, id IDInput, state *ServicePrincipalCertificateState, opts ...ResourceOption) (*ServicePrincipalCertificate, error)
public static ServicePrincipalCertificate Get(string name, Input<string> id, ServicePrincipalCertificateState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Encoding string
Specifies the encoding used for the supplied certificate data. Must be one of pem, base64 or hex. Defaults to pem.
EndDate string
The End Date which the Certificate is valid until, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.
EndDateRelative string
A relative duration for which the Certificate is valid until, for example 240h (10 days) or 2400h30m. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. Changing this field forces a new resource to be created.
KeyId string
A GUID used to uniquely identify this Certificate. If not specified a GUID will be created. Changing this field forces a new resource to be created.
ServicePrincipalId string
The ID of the Service Principal for which this certificate should be created. Changing this field forces a new resource to be created.
StartDate string
The Start Date which the Certificate is valid from, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). If this isn’t specified, the current date is used. Changing this field forces a new resource to be created.
Type string
The type of key/certificate. Must be one of AsymmetricX509Cert or Symmetric. Changing this fields forces a new resource to be created.
Value string
The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the encoding argument.
Encoding string
Specifies the encoding used for the supplied certificate data. Must be one of pem, base64 or hex. Defaults to pem.
EndDate string
The End Date which the Certificate is valid until, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.
EndDateRelative string
A relative duration for which the Certificate is valid until, for example 240h (10 days) or 2400h30m. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. Changing this field forces a new resource to be created.
KeyId string
A GUID used to uniquely identify this Certificate. If not specified a GUID will be created. Changing this field forces a new resource to be created.
ServicePrincipalId string
The ID of the Service Principal for which this certificate should be created. Changing this field forces a new resource to be created.
StartDate string
The Start Date which the Certificate is valid from, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). If this isn’t specified, the current date is used. Changing this field forces a new resource to be created.
Type string
The type of key/certificate. Must be one of AsymmetricX509Cert or Symmetric. Changing this fields forces a new resource to be created.
Value string
The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the encoding argument.
encoding string
Specifies the encoding used for the supplied certificate data. Must be one of pem, base64 or hex. Defaults to pem.
endDate string
The End Date which the Certificate is valid until, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.
endDateRelative string
A relative duration for which the Certificate is valid until, for example 240h (10 days) or 2400h30m. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. Changing this field forces a new resource to be created.
keyId string
A GUID used to uniquely identify this Certificate. If not specified a GUID will be created. Changing this field forces a new resource to be created.
servicePrincipalId string
The ID of the Service Principal for which this certificate should be created. Changing this field forces a new resource to be created.
startDate string
The Start Date which the Certificate is valid from, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). If this isn’t specified, the current date is used. Changing this field forces a new resource to be created.
type string
The type of key/certificate. Must be one of AsymmetricX509Cert or Symmetric. Changing this fields forces a new resource to be created.
value string
The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the encoding argument.
encoding str
Specifies the encoding used for the supplied certificate data. Must be one of pem, base64 or hex. Defaults to pem.
end_date str
The End Date which the Certificate is valid until, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.
end_date_relative str
A relative duration for which the Certificate is valid until, for example 240h (10 days) or 2400h30m. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. Changing this field forces a new resource to be created.
key_id str
A GUID used to uniquely identify this Certificate. If not specified a GUID will be created. Changing this field forces a new resource to be created.
service_principal_id str
The ID of the Service Principal for which this certificate should be created. Changing this field forces a new resource to be created.
start_date str
The Start Date which the Certificate is valid from, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). If this isn’t specified, the current date is used. Changing this field forces a new resource to be created.
type str
The type of key/certificate. Must be one of AsymmetricX509Cert or Symmetric. Changing this fields forces a new resource to be created.
value str
The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the encoding argument.

Import

Certificates can be imported using the object id of the Service Principal and the key id of the certificate, e.g.

 $ pulumi import azuread:index/servicePrincipalCertificate:ServicePrincipalCertificate test 00000000-0000-0000-0000-000000000000/certificate/11111111-1111-1111-1111-111111111111

Package Details

Repository
https://github.com/pulumi/pulumi-azuread
License
Apache-2.0
Notes
This Pulumi package is based on the azuread Terraform Provider.